Package group24.escaperoom.entities.properties

Class AnimatedProperty

java.lang.Object

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

group24.escaperoom.entities.properties.PhantomProperty

group24.escaperoom.entities.properties.AnimatedProperty

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class AnimatedProperty
extends PhantomProperty

Animated items have a texture that is `N` item widths wide, where N is the number of frames in the animation and width is in pixels.

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	Constant used for default frame guessing

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

owner

Constructor Summary

Constructors

Constructor	Description
AnimatedProperty()	Empty constructor for Json.Serializable compatability
AnimatedProperty(Item owner, int numFrames, float frameLength, int frameWidth, int frameHeight)

Method Summary

Modifier and Type	Method	Description
void	apply(Item item)
AnimatedProperty	cloneProperty(Item newOwner)
void	defaultConfiguration(Item owner)
Optional<PropertyConfiguration>	getCustomItemConfigurationMenu()	Get a PropertyConfiguration that contains all fields necessary to configure this property in the ItemEditor
PropertyDescription	getDescription()
String	getDisplayName()
PropertyType	getType()
void	maybeAdvance(float delta)	Maybe advance the animation frame
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

getAvailableActions, getInputType, getPotentialValues, getValueClass

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

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

Constant used for default frame guessing

See Also:

• Constant Field Values

Constructor Details

AnimatedProperty

public AnimatedProperty(Item owner,
 int numFrames,
 float frameLength,
 int frameWidth,
 int frameHeight)

Parameters:

owner - the owner of this property

numFrames - is the number of frames available in the texture of the item

frameLength - is the time in seconds that each frame should play for

frameWidth - is the width, in pixels, of an individual frame

frameHeight - is the height, in pixels, of an individual frame

AnimatedProperty

public AnimatedProperty()

Empty constructor for Json.Serializable compatability

Method Details

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

the PropertyDescription of this Property

maybeAdvance

public void maybeAdvance(float delta)

Maybe advance the animation frame

Parameters:

delta - the amount of game time passed since the last call

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 AnimatedProperty 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>

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

apply

public void apply(Item item)

Overrides:

apply in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Parameters:

item - apply this property to this item

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

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