jalse.entities

Interface EntityFactory

All Known Implementing Classes:

DefaultEntityFactory

public interface EntityFactory

An entity factory is used to control the creation, transfer and killing of Entity within the entire tree.

See Also:

DefaultEntityContainer, DefaultEntityFactory

Method Summary

Modifier and Type	Method and Description
void	exportEntity(Entity e) Exports an entity (removing all references).
Entity	newEntity(java.util.UUID id, EntityContainer target) Creates a new entity with the specified ID and parent container.
void	setEngine(ActionEngine engine) Sets the engine to supply to new entities.
boolean	tryImportEntity(Entity e, EntityContainer target) Imports the entity into the factory.
boolean	tryKillEntity(Entity e) Kills the specified entity.
boolean	tryTakeFromTree(Entity e, EntityContainer target) Tries to take the entity from within the tree if possible.
boolean	withinSameTree(EntityContainer source, EntityContainer target) Checks if the two containers are within the same tree (for in tree transfer or export).

Method Detail

exportEntity

void exportEntity(Entity e)

Exports an entity (removing all references).

Parameters:

e - Entity to detach.

newEntity

Entity newEntity(java.util.UUID id,
                 EntityContainer target)

Creates a new entity with the specified ID and parent container.

Parameters:

id - Entity ID.

target - Parent container.

Returns:

Newly created entity.

setEngine

void setEngine(ActionEngine engine)

Sets the engine to supply to new entities.

Parameters:

engine - Action engine.

tryImportEntity

boolean tryImportEntity(Entity e,
                        EntityContainer target)

Imports the entity into the factory.

Parameters:

e - Entity to import.

target - Target container.

Returns:

Whether the entity was imported.

tryKillEntity

boolean tryKillEntity(Entity e)

Kills the specified entity.

Parameters:

e - Entity to kill.

Returns:

Whether the entity was killed.

tryTakeFromTree

boolean tryTakeFromTree(Entity e,
                        EntityContainer target)

Tries to take the entity from within the tree if possible.

Parameters:

e - Entity to take.

target - Target container.

Returns:

Whether the entity could be taken from within the tree.

withinSameTree

boolean withinSameTree(EntityContainer source,
                       EntityContainer target)

Checks if the two containers are within the same tree (for in tree transfer or export).

Parameters:

source - Source container.

target - Target container.

Returns:

Whether they're within the same tree.