Package group24.escaperoom.entities.properties

Class Connector

java.lang.Object

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

group24.escaperoom.entities.properties.PhantomProperty

group24.escaperoom.entities.properties.Connector

All Implemented Interfaces:

com.badlogic.gdx.utils.Json.Serializable, Connectable

Direct Known Subclasses:

ConnectorBridge, ConnectorRelay, ConnectorSink, ConnectorSource

public class Connector
extends PhantomProperty
implements Connectable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Connector.ConnectorType

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

Nested classes/interfaces inherited from interface group24.escaperoom.entities.properties.Connectable

Connectable.ConnectableItem, Connectable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	connected
protected Connector.ConnectorType	type

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

owner

Fields inherited from interface group24.escaperoom.entities.properties.Connectable

defaultConnectionDirections

Constructor Summary

Constructors

Constructor	Description
Connector()

Method Summary

Modifier and Type	Method	Description
void	acceptSignalFrom(Connectable source, Types.IntVector2 position, GameContext ctx, HashSet<Integer> seen)	Called when this Connectable receives a signal from another.
Connector.ConnectorType	getConnectorType()	Get the type of connector.
Optional<PropertyConfiguration>	getCustomItemConfigurationMenu()	Get a PropertyConfiguration that contains all fields necessary to configure this property in the ItemEditor
PropertyDescription	getDescription()
String	getDisplayName()
PropertyType	getType()
boolean	isConnected()	Get whether or not this Connectable is connected (active)
void	propagate(GameContext ctx, HashSet<Integer> seen)	Potentially propagate the the connectors current siganl
void	read(com.badlogic.gdx.utils.Json json, com.badlogic.gdx.utils.JsonValue jsonData)
void	setActive(boolean connected, GameContext ctx)	Set the Connectable to be connected This may or may not propagate the signal
protected void	updateColor()
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, cloneProperty, 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

Methods inherited from interface group24.escaperoom.entities.properties.Connectable

connectionDirections

Field Details

type

protected Connector.ConnectorType type

connected

protected boolean connected

Constructor Details

Connector

public Connector()

Method Details

getDescription

public PropertyDescription getDescription()

Specified by:

getDescription in class ItemProperty<PhantomProperty.PhantomPropertyValue>

Returns:

the PropertyDescription of this Property

getConnectorType

public Connector.ConnectorType getConnectorType()

Description copied from interface: Connectable

Get the type of connector.

Specified by:

getConnectorType in interface Connectable

propagate

public void propagate(GameContext ctx,
 HashSet<Integer> seen)

Description copied from interface: Connectable

Potentially propagate the the connectors current siganl

Specified by:

propagate in interface Connectable

seen - is IDs of all Connectable items which have already propagated

setActive

public void setActive(boolean connected,
 GameContext ctx)

Description copied from interface: Connectable

Set the Connectable to be connected This may or may not propagate the signal

Specified by:

setActive in interface Connectable

isConnected

public boolean isConnected()

Description copied from interface: Connectable

Get whether or not this Connectable is connected (active)

Specified by:

isConnected in interface Connectable

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)

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

updateColor

protected void updateColor()

acceptSignalFrom

public void acceptSignalFrom(Connectable source,
 Types.IntVector2 position,
 GameContext ctx,
 HashSet<Integer> seen)

Description copied from interface: Connectable

Called when this Connectable receives a signal from another.

Specified by:

acceptSignalFrom in interface Connectable

Parameters:

source - the Connectable sending the signal

position - the source's position

seen - A set of already visited IDs

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