Package group24.escaperoom.entities.properties

Class Collideable

java.lang.Object

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

group24.escaperoom.entities.properties.PhantomProperty

group24.escaperoom.entities.properties.Collideable

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable

public class Collideable
extends PhantomProperty

Collidable items block the player movement. This can be configured to be an area that is not equal to the items actual size.

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
Collideable()	Empty constructor for Json.Serializable compatability constructor
Collideable(Item item)	Convience constructor for when the owner's whole region blocks the player
Collideable(Item item, float dx, float dy, float width, float height)

Method Summary

Modifier and Type	Method	Description
Collideable	cloneProperty(Item newOwner)
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	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData)
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, updateTexture

Methods inherited from class java.lang.Object

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

Constructor Details

Collideable

public Collideable()

Empty constructor for Json.Serializable compatability constructor

Collideable

public Collideable(Item item,
 float dx,
 float dy,
 float width,
 float height)

Parameters:

item - owner

dx - offset from the bottom left corner where the blocking region begins

dy - offset from the bottom left corner where the blocking region begins

width - of the blocking region

height - of the blocking region

Collideable

public Collideable(Item item)

Convience constructor for when the owner's whole region blocks the player

Parameters:

item - owner

Method Details

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

the PropertyDescription of this Property

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

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

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