com.artemis

Class EntityManager

java.lang.Object

com.artemis.BaseSystem

com.artemis.EntityManager

@SkipWire
public class EntityManager
extends BaseSystem

Manages entity instances.

Author:

Arni Arent, Adrian Papari

Field Summary

Fields inherited from class com.artemis.BaseSystem

world

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected int	create() Create a new entity.
protected Entity	createEntityInstance() Create a new entity.
protected Entity	getEntity(int entityId) Resolves entity id to the unique entity instance.
boolean	isActive(int entityId) Check if this entity is active.
protected void	processSystem() Process the system.
void	registerEntityStore(BitVector bv)
boolean	reset() If all entties have been deleted, resets the entity cache - with next entity entity receiving id 0.

Methods inherited from class com.artemis.BaseSystem

begin, checkProcessing, dispose, end, getWorld, initialize, isEnabled, process, setEnabled, 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

processSystem

protected void processSystem()

Description copied from class: BaseSystem

Process the system.

Specified by:

processSystem in class BaseSystem

createEntityInstance

protected Entity createEntityInstance()

Create a new entity.

Returns:

a new entity

create

protected int create()

Create a new entity.

Returns:

a new entity id

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

registerEntityStore

public void registerEntityStore(BitVector bv)

getEntity

protected Entity getEntity(int entityId)

Resolves entity id to the unique entity instance. This method may return an entity even if it isn't active in the world, use isActive(int) if you need to check whether the entity is active or not.

Parameters:

entityId - the entities id

Returns:

the entity

reset

public boolean reset()

If all entties have been deleted, resets the entity cache - with next entity entity receiving id 0. There mustn't be any active entities in the world for this method to work. This method does nothing if it fails.

For the reset to take effect, a new World.process() must initiate.

Returns:

true if entity id was successfully reset.