com.almasb.fxgl.entity

Class EntityEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

com.almasb.fxgl.entity.EntityEvent

All Implemented Interfaces:

Serializable, Cloneable

public final class EntityEvent
extends javafx.event.Event

A general entity event. Keeps track of its trigger and target entities. Trigger entity is the one that triggered the event. Target entity (if exists) is the one that is targeted by the event. If target entity doesn't exist then it is the same as trigger entity.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.event.EventType<EntityEvent>	ACTIVATE
static javafx.event.EventType<EntityEvent>	ANY
static javafx.event.EventType<EntityEvent>	DEATH
static javafx.event.EventType<EntityEvent>	REVIVE

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
EntityEvent(javafx.event.EventType<? extends javafx.event.Event> eventType, Entity triggerEntity) Constructs entity event with given type and trigger entity.
EntityEvent(javafx.event.EventType<? extends javafx.event.Event> eventType, Entity triggerEntity, Entity targetEntity) Constructs entity event with given type, trigger entity and the entity being targeted by the event.

Method Summary

Modifier and Type	Method and Description
ObjectMap<String,Object>	getData()
<T> T	getData(String key)
<T> Optional<T>	getDataOptional(String key)
Entity	getTargetEntity() Returns entity that was target of the event.
Entity	getTriggerEntity()
void	setData(String key, Object value)
String	toString()

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final javafx.event.EventType<EntityEvent> ANY

ACTIVATE

public static final javafx.event.EventType<EntityEvent> ACTIVATE

DEATH

public static final javafx.event.EventType<EntityEvent> DEATH

REVIVE

public static final javafx.event.EventType<EntityEvent> REVIVE

Constructor Detail

EntityEvent

public EntityEvent(javafx.event.EventType<? extends javafx.event.Event> eventType,
                   Entity triggerEntity,
                   Entity targetEntity)

Constructs entity event with given type, trigger entity and the entity being targeted by the event.

Parameters:

eventType - type

triggerEntity - trigger entity

targetEntity - target entity

EntityEvent

public EntityEvent(javafx.event.EventType<? extends javafx.event.Event> eventType,
                   Entity triggerEntity)

Constructs entity event with given type and trigger entity. Target entity is set to trigger entity.

Parameters:

eventType - type

triggerEntity - trigger entity

Method Detail

getData

public ObjectMap<String,Object> getData()

getTriggerEntity

public Entity getTriggerEntity()

Returns:

entity that triggered this event

getTargetEntity

public Entity getTargetEntity()

Returns entity that was target of the event. Note that if there is no target entity then it is the same as trigger entity.

Returns:

target entity

setData

public final void setData(String key,
                          Object value)

Parameters:

key - property key

value - property value

getData

public final <T> T getData(String key)

Parameters:

key - property key

Returns:

property value or null if key not present

getDataOptional

public final <T> Optional<T> getDataOptional(String key)

Parameters:

key - property key

Returns:

property value or Optional.empty() if value is null or key not present

toString

public String toString()

Overrides:

toString in class EventObject