jalse.entities

Class EntityEvent

java.lang.Object

jalse.misc.AbstractIdentifiable

jalse.entities.EntityEvent

All Implemented Interfaces:

Identifiable

public class EntityEvent
extends AbstractIdentifiable

Entity change event for EntityListener. This is a unique event that contains the relevant Entity and it's parent EntityContainer (even if the Entity has been killed).

See Also:

EntityContainer

Field Summary

Fields inherited from class jalse.misc.AbstractIdentifiable

id

Constructor Summary

Constructors

Constructor and Description
EntityEvent(EntityContainer container, Entity entity) Creates a new EntityEvent with a random ID.
EntityEvent(EntityContainer container, Entity entity, EntityContainer destination) Creates a new EntityEvent with a random ID.

Method Summary

Modifier and Type	Method and Description
EntityContainer	getContainer() Gets the Entity's parent container.
EntityContainer	getDestinationContainer() Get the destination container for the transfer event.
Entity	getEntity() Gets the event entity.
java.util.Optional<EntityContainer>	getOptDestinationContainer() Get the destination container for the transfer event.
boolean	isTransfer() Checks whether this is a transfer event.

Methods inherited from class jalse.misc.AbstractIdentifiable

equals, getID, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jalse.misc.Identifiable

equals, getID, hashCode, is, not, toString

Constructor Detail

EntityEvent

public EntityEvent(EntityContainer container,
                   Entity entity)

Creates a new EntityEvent with a random ID.

Parameters:

container - Parent container for the Entity.

entity - Entity the event is for.

EntityEvent

public EntityEvent(EntityContainer container,
                   Entity entity,
                   EntityContainer destination)

Creates a new EntityEvent with a random ID.

Parameters:

container - Parent container for the entity.

entity - Entity the event is for.

destination - Destination container for transfer events (can be null).

Method Detail

getContainer

public EntityContainer getContainer()

Gets the Entity's parent container.

Returns:

Entity's parent container.

getDestinationContainer

public EntityContainer getDestinationContainer()

Get the destination container for the transfer event.

Returns:

Destination container or null if there was not one.

getEntity

public Entity getEntity()

Gets the event entity.

Returns:

The entity the event was triggered for.

getOptDestinationContainer

public java.util.Optional<EntityContainer> getOptDestinationContainer()

Get the destination container for the transfer event.

Returns:

Optional containing the destination container or empty optional if nothing was transferred.

isTransfer

public boolean isTransfer()

Checks whether this is a transfer event.

Returns:

Whether there is a destination container.