com.artemis

Class EntityManager

java.lang.Object

com.artemis.Manager

com.artemis.EntityManager

All Implemented Interfaces:

EntityObserver

public class EntityManager
extends Manager

EntityManager.

Author:

Arni Arent

Field Summary

Fields inherited from class com.artemis.Manager

world

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityManager(int initialContainerSize) Creates a new EntityManager Instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	added(Entity e) Adds the entity to this manager.
protected void	clean()
protected Entity	createEntityInstance() Create a new entity.
protected Entity	createEntityInstance(ArchetypeBuilder.Archetype archetype) Create a new entity based on the supplied archetype.
void	deleted(Entity e) Removes the entity from the manager, freeing it's id for new entities.
void	disabled(Entity e) Sets the entity as disabled in the manager.
void	enabled(Entity e) Deprecated. create your own components to track state.
int	getActiveEntityCount() Get how many entities are active in this world.
protected Entity	getEntity(int entityId) Get a entity with this id.
protected int	getIdentity(Entity e)
long	getTotalAdded() Get how many entities have been added to the world since start.
long	getTotalCreated() Get how many entities have been created in the world since start.
long	getTotalDeleted() Get how many entities have been deleted from the world since start.
protected void	initialize() Called when the world initializes.
boolean	isActive(int entityId) Check if this entity is active.
boolean	isEnabled(int entityId) Deprecated. create your own components to track state.

Methods inherited from class com.artemis.Manager

added, changed, changed, deleted, dispose, getWorld, setWorld

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityManager

protected EntityManager(int initialContainerSize)

Creates a new EntityManager Instance.

Method Detail

initialize

protected void initialize()

Description copied from class: Manager

Called when the world initializes.

Override to implement custom behavior at initialization.

Overrides:

initialize in class Manager

createEntityInstance

protected Entity createEntityInstance()

Create a new entity.

Returns:

a new entity

createEntityInstance

protected Entity createEntityInstance(ArchetypeBuilder.Archetype archetype)

Create a new entity based on the supplied archetype.

Returns:

a new entity

added

public void added(Entity e)

Adds the entity to this manager.

Called by the world when an entity is added.

Specified by:

added in interface EntityObserver

Overrides:

added in class Manager

Parameters:

e - the entity to add

enabled

@Deprecated
public void enabled(Entity e)

Deprecated. create your own components to track state.

Sets the entity (re)enabled in the manager.

Specified by:

enabled in interface EntityObserver

Overrides:

enabled in class Manager

Parameters:

e - the entity to (re)enable

disabled

public void disabled(Entity e)

Sets the entity as disabled in the manager.

Specified by:

disabled in interface EntityObserver

Overrides:

disabled in class Manager

Parameters:

e - the entity to disable

deleted

public void deleted(Entity e)

Removes the entity from the manager, freeing it's id for new entities.

Specified by:

deleted in interface EntityObserver

Overrides:

deleted in class Manager

Parameters:

e - the entity to remove

isActive

public boolean isActive(int entityId)

Check if this entity is active.

Active means the entity is being actively processed.

Parameters:

entityId - the entities id

Returns:

true if active, false if not

isEnabled

@Deprecated
public boolean isEnabled(int entityId)

Deprecated. create your own components to track state.

Check if the specified entityId is enabled.

Parameters:

entityId - the entities id

Returns:

true if the entity is enabled, false if it is disabled

getEntity

protected Entity getEntity(int entityId)

Get a entity with this id.

Parameters:

entityId - the entities id

Returns:

the entity

getActiveEntityCount

public int getActiveEntityCount()

Get how many entities are active in this world.

Returns:

how many entities are currently active

getTotalCreated

public long getTotalCreated()

Get how many entities have been created in the world since start.

Note: A created entity may not have been added to the world, thus created count is always equal or larger than added count.

Returns:

how many entities have been created since start

getTotalAdded

public long getTotalAdded()

Get how many entities have been added to the world since start.

Returns:

how many entities have been added

getTotalDeleted

public long getTotalDeleted()

Get how many entities have been deleted from the world since start.

Returns:

how many entities have been deleted since start

clean

protected void clean()

getIdentity

protected int getIdentity(Entity e)