com.almasb.fxgl.ecs

Class EntityWorld

java.lang.Object

com.almasb.fxgl.ecs.EntityWorld

Direct Known Subclasses:

GameWorld

public class EntityWorld
extends Object

Manages entities and allows queries. Can be extended to provide specific functionality.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Entity>	entities List of entities in the world.

Constructor Summary

Constructors

Constructor and Description
EntityWorld() Constructs the world with initial entity capacity = 32.
EntityWorld(int initialCapacity) Constructs the world with given initial entity capacity.

Method Summary

Modifier and Type	Method and Description
void	addEntities(Entity... entitiesToAdd)
void	addEntity(Entity entity) Adds entity to this world.
void	addWorldListener(EntityWorldListener listener) Add world listener to be notified of events.
List<Entity>	getEntities()
Array<Entity>	getEntitiesByComponent(Class<? extends Component> type)
List<Entity>	getEntitiesCopy() Returns entities currently registered in the world.
void	removeEntities(Entity... entitiesToRemove)
void	removeEntity(Entity entity)
void	removeWorldListener(EntityWorldListener listener) Remove world listener.
protected void	reset() Resets the world to its initial state.
protected void	update(double tpf) Performs a single world update tick.

Methods inherited from class java.lang.Object

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

Field Detail

entities

protected List<Entity> entities

List of entities in the world.

Constructor Detail

EntityWorld

public EntityWorld()

Constructs the world with initial entity capacity = 32.

EntityWorld

public EntityWorld(int initialCapacity)

Constructs the world with given initial entity capacity.

Parameters:

initialCapacity - initial entity capacity

Method Detail

addEntity

public final void addEntity(Entity entity)

Adds entity to this world. The entity will be added to update list in the next tick.

Parameters:

entity - the entity to add to world

addEntities

public final void addEntities(Entity... entitiesToAdd)

Parameters:

entitiesToAdd - the entities to add to world

removeEntity

public final void removeEntity(Entity entity)

Parameters:

entity - the entity to remove from world

removeEntities

public final void removeEntities(Entity... entitiesToRemove)

Parameters:

entitiesToRemove - the entity to remove from world

update

protected void update(double tpf)

Performs a single world update tick.

Parameters:

tpf - time per frame

reset

protected void reset()

Resets the world to its initial state. Does NOT clear state listeners.

addWorldListener

public final void addWorldListener(EntityWorldListener listener)

Add world listener to be notified of events.

Parameters:

listener - the listener

removeWorldListener

public final void removeWorldListener(EntityWorldListener listener)

Remove world listener.

Parameters:

listener - the listener

getEntities

public final List<Entity> getEntities()

Returns:

direct list of entities in the world (do NOT modify)

getEntitiesCopy

public final List<Entity> getEntitiesCopy()

Returns entities currently registered in the world.

Returns:

shallow copy of the entities list (new list)

getEntitiesByComponent

public final Array<Entity> getEntitiesByComponent(Class<? extends Component> type)

Parameters:

type - component type

Returns:

array of entities that have given component (do NOT modify)