Package group24.escaperoom.entities.properties

Class Toggleable

java.lang.Object

group24.escaperoom.entities.properties.ItemProperty<PhantomProperty.PhantomPropertyValue>

group24.escaperoom.entities.properties.PhantomProperty

group24.escaperoom.entities.properties.Toggleable

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class Toggleable
extends PhantomProperty

An item implementing Toggleable should have a texture

Nested Class Summary

Nested classes/interfaces inherited from class group24.escaperoom.entities.properties.PhantomProperty

PhantomProperty.PhantomPropertyValue

Nested classes/interfaces inherited from class group24.escaperoom.entities.properties.ItemProperty

ItemProperty.MenuType

Field Summary

Fields inherited from class group24.escaperoom.entities.properties.ItemProperty

owner

Constructor Summary

Constructors

Constructor	Description
Toggleable()

Method Summary

Modifier and Type	Method	Description
void	defaultConfiguration(Item owner)
com.badlogic.gdx.utils.Array<PlayerAction>	getAvailableActions()
PropertyDescription	getDescription()
String	getDisplayName()
PropertyType	getType()
boolean	isToggled()
void	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData)
void	updateTexture()	Updates the owner's texture based on the property.
void	write(com.badlogic.gdx.utils.Json json)

Methods inherited from class group24.escaperoom.entities.properties.PhantomProperty

getInputType, getPotentialValues, getValueClass

Methods inherited from class group24.escaperoom.entities.properties.ItemProperty

apply, cloneProperty, getActions, getCurrentValue, getCurrentValues, getCustomItemConfigurationMenu, getOwner, getPopOut, set, set, setOwner, unsafeSet, unsafeSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Toggleable

public Toggleable()

Method Details

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

name of this property, used as a display string in menus

getType

public PropertyType getType()

Specified by:

getType in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

PropertyType of this property. This allows us to get the property of an item from it's property map

See Also:

• Item.getProperty(group24.escaperoom.entities.properties.PropertyType)

isToggled

public boolean isToggled()

getAvailableActions

public com.badlogic.gdx.utils.Array<PlayerAction> getAvailableActions()

Overrides:

getAvailableActions in class PhantomProperty

Returns:

all available PlayerAction

write

public void write(com.badlogic.gdx.utils.Json json)

Specified by:

write in interface com.badlogic.gdx.utils.Json.Serializable

Overrides:

write in class PhantomProperty

read

public void read(com.badlogic.gdx.utils.Json json,
 com.badlogic.gdx.utils.JsonValue jsonData)

Specified by:

read in interface com.badlogic.gdx.utils.Json.Serializable

Overrides:

read in class PhantomProperty

updateTexture

public void updateTexture()

Description copied from class: ItemProperty

Updates the owner's texture based on the property. Properties which do not change the texture should not override this function. Typically used when reloading textures on already placed items.

Overrides:

updateTexture in class ItemProperty<PhantomProperty.PhantomPropertyValue>

defaultConfiguration

public void defaultConfiguration(Item owner)

Overrides:

defaultConfiguration in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Parameters:

owner - create a default configuration of this property for the given owner

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

the PropertyDescription of this Property