Package group24.escaperoom.entities.properties

Class LockedProperty

java.lang.Object

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

group24.escaperoom.entities.properties.LockedProperty

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class LockedProperty
extends ItemProperty<LockingMethod>

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

Method Summary

Modifier and Type	Method	Description
LockedProperty	cloneProperty(Item newOwner)
com.badlogic.gdx.utils.Array<PlayerAction>	getAvailableActions()
LockingMethod	getCurrentValue()
Optional<PropertyConfiguration>	getCustomItemConfigurationMenu()	Get a PropertyConfiguration that contains all fields necessary to configure this property in the ItemEditor
PropertyDescription	getDescription()
String	getDisplayName()
LockingMethod	getEmptyLockMethod(LockingMethodType type)
ItemProperty.MenuType	getInputType()
com.badlogic.gdx.utils.Array<LockingMethod>	getPotentialValues()
PropertyType	getType()
Class<LockingMethod>	getValueClass()
boolean	isLocked()
void	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData)
void	set(LockingMethod 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, defaultConfiguration, getActions, getCurrentValues, getOwner, getPopOut, 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

LockedProperty

public LockedProperty()

Empty constructor for Json.Serializable compatability constructor

Method Details

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<LockingMethod>

Returns:

the PropertyDescription of this Property

isLocked

public boolean isLocked()

getPotentialValues

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

Specified by:

getPotentialValues in class ItemProperty<LockingMethod>

Returns:

all possible values for this property

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class ItemProperty<LockingMethod>

Returns:

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

getType

public PropertyType getType()

Specified by:

getType in class ItemProperty<LockingMethod>

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(LockingMethod 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<LockingMethod>

Parameters:

value - to set

getCurrentValue

public LockingMethod getCurrentValue()

Overrides:

getCurrentValue in class ItemProperty<LockingMethod>

Returns:

the current value of this property

getInputType

public ItemProperty.MenuType getInputType()

Specified by:

getInputType in class ItemProperty<LockingMethod>

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

getAvailableActions

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

Specified by:

getAvailableActions in class ItemProperty<LockingMethod>

Returns:

all available PlayerAction

cloneProperty

public LockedProperty cloneProperty(Item newOwner)

Overrides:

cloneProperty in class ItemProperty<LockingMethod>

Parameters:

newOwner - the new owner of this property

Returns:

a clone of this item property (along with state and values) for a new item

write

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

getEmptyLockMethod

public LockingMethod getEmptyLockMethod(LockingMethodType type)

read

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

getValueClass

public Class<LockingMethod> getValueClass()

Specified by:

getValueClass in class ItemProperty<LockingMethod>

Returns:

the class of the ItemPropertyValue for this property

getCustomItemConfigurationMenu

public Optional<PropertyConfiguration> getCustomItemConfigurationMenu()

Description copied from class: ItemProperty

Get a PropertyConfiguration that contains all fields necessary to configure this property in the ItemEditor

Overrides:

getCustomItemConfigurationMenu in class ItemProperty<LockingMethod>

Returns:

Some(PropertyConfiguration) should this property need configuration