Package group24.escaperoom.entities.properties

Class SpinnableProperty

java.lang.Object

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

group24.escaperoom.entities.properties.PhantomProperty

group24.escaperoom.entities.properties.SpinnableProperty

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class SpinnableProperty
extends PhantomProperty

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

Modifier and Type	Field	Description
static final int	PIXELS_PER_WORLD_UNIT

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

owner

Constructor Summary

Constructors

Constructor	Description
SpinnableProperty()	Empty constructor for Json.Serializable compatability
SpinnableProperty(Item owner, int pixelWidth, int pixelHeight, int spinCount)

Method Summary

Modifier and Type	Method	Description
SpinnableProperty	cloneProperty(Item newOwner)
static int	degreesToSpinCount(float degrees)
Optional<PropertyConfiguration>	getCustomItemConfigurationMenu()	Get a PropertyConfiguration that contains all fields necessary to configure this property in the ItemEditor
PropertyDescription	getDescription()
String	getDisplayName()
int	getSpinCount()
PropertyType	getType()
void	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData)
void	setSpin(int spinCount)
void	updateSize()
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

getAvailableActions, getInputType, getPotentialValues, getValueClass

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

apply, defaultConfiguration, getActions, getCurrentValue, getCurrentValues, 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

Field Details

PIXELS_PER_WORLD_UNIT

public static final int PIXELS_PER_WORLD_UNIT

See Also:

• Constant Field Values

Constructor Details

SpinnableProperty

public SpinnableProperty()

Empty constructor for Json.Serializable compatability

SpinnableProperty

public SpinnableProperty(Item owner,
 int pixelWidth,
 int pixelHeight,
 int spinCount)

Method Details

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

the PropertyDescription of this Property

updateSize

public void updateSize()

setSpin

public void setSpin(int spinCount)

getSpinCount

public int getSpinCount()

degreesToSpinCount

public static int degreesToSpinCount(float degrees)

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)

cloneProperty

public SpinnableProperty cloneProperty(Item newOwner)

Overrides:

cloneProperty in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Parameters:

newOwner - the new owner of this property

Returns:

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

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>

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<PhantomProperty.PhantomPropertyValue>

Returns:

Some(PropertyConfiguration) should this property need configuration

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