Package group24.escaperoom.entities.properties

Class ReadableProperty

java.lang.Object

group24.escaperoom.entities.properties.ItemProperty<ReadableContents>

group24.escaperoom.entities.properties.ReadableProperty

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class ReadableProperty
extends ItemProperty<ReadableContents>

Nested Class Summary

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
ReadableProperty()	Empty constructor for Json.Serializable compatability constructor
ReadableProperty(String title)

Method Summary

Modifier and Type	Method	Description
com.badlogic.gdx.utils.Array<PlayerAction>	getAvailableActions()
ReadableContents	getCurrentValue()
PropertyDescription	getDescription()
String	getDisplayName()
ItemProperty.MenuType	getInputType()
ConfigurationMenu<SimpleUI>	getPopOut(Menu.MenuEntry parent)	If this property specifies ItemProperty.MenuType.PopOut This function will be called to get the Menu which should be displayed when this property is selected.
com.badlogic.gdx.utils.Array<ReadableContents>	getPotentialValues()
PropertyType	getType()
Class<ReadableContents>	getValueClass()
void	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData)
void	set(ReadableContents value)	Set the value of this property to value It is the responsibility of the caller to only pass values that are recieved from ItemProperty.getPotentialValues()
void	write(com.badlogic.gdx.utils.Json json)

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

apply, cloneProperty, defaultConfiguration, getActions, getCurrentValues, getCustomItemConfigurationMenu, getOwner, set, setOwner, unsafeSet, unsafeSet, updateTexture

Methods inherited from class java.lang.Object

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

Constructor Details

ReadableProperty

public ReadableProperty()

Empty constructor for Json.Serializable compatability constructor

ReadableProperty

public ReadableProperty(String title)

Method Details

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<ReadableContents>

Returns:

the PropertyDescription of this Property

getPotentialValues

public com.badlogic.gdx.utils.Array<ReadableContents> getPotentialValues()

Specified by:

getPotentialValues in class ItemProperty<ReadableContents>

Returns:

all possible values for this property

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class ItemProperty<ReadableContents>

Returns:

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

getType

public PropertyType getType()

Specified by:

getType in class ItemProperty<ReadableContents>

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)

set

public void set(ReadableContents value)

Description copied from class: ItemProperty

Set the value of this property to value It is the responsibility of the caller to only pass values that are recieved from ItemProperty.getPotentialValues()

Overrides:

set in class ItemProperty<ReadableContents>

Parameters:

value - to set

getInputType

public ItemProperty.MenuType getInputType()

Specified by:

getInputType in class ItemProperty<ReadableContents>

Returns:

the ItemProperty.MenuType that should be used to recieve and display the ItemPropertyValue associated with this property - adding a new input type requires updating ItemMenu to support it

getPopOut

public ConfigurationMenu<SimpleUI> getPopOut(Menu.MenuEntry parent)

Description copied from class: ItemProperty

If this property specifies ItemProperty.MenuType.PopOut This function will be called to get the Menu which should be displayed when this property is selected.

Overrides:

getPopOut in class ItemProperty<ReadableContents>

Parameters:

parent - Menu.MenuEntry spawning this menu

Returns:

the menu to display

getCurrentValue

public ReadableContents getCurrentValue()

Overrides:

getCurrentValue in class ItemProperty<ReadableContents>

Returns:

the current value of this property

getAvailableActions

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

Specified by:

getAvailableActions in class ItemProperty<ReadableContents>

Returns:

all available PlayerAction

write

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

read

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

getValueClass

public Class<ReadableContents> getValueClass()

Specified by:

getValueClass in class ItemProperty<ReadableContents>

Returns:

the class of the ItemPropertyValue for this property