com.artemis

Class BaseEntitySystem

java.lang.Object

com.artemis.BaseSystem

com.artemis.BaseEntitySystem

All Implemented Interfaces:

EntitySubscription.SubscriptionListener

Direct Known Subclasses:

DelayedIteratingSystem, EntityLinkManager, EntitySystem, IntervalSystem, IteratingSystem

public abstract class BaseEntitySystem
extends BaseSystem
implements EntitySubscription.SubscriptionListener

Tracks a subset of entities, but does not implement any sorting or iteration.

Author:

Arni Arent, Adrian Papari

Field Summary

Fields

Modifier and Type	Field and Description
protected EntitySubscription	subscription

Fields inherited from class com.artemis.BaseSystem

world

Constructor Summary

Constructors

Constructor and Description
BaseEntitySystem()
BaseEntitySystem(Aspect.Builder aspect) Creates an entity system that uses the specified aspect as a matcher against entities.

Method Summary

Modifier and Type	Method and Description
IntBag	getEntityIds() Gets the entities processed by this system.
EntitySubscription	getSubscription()
protected void	inserted(int entityId) Called if entity has come into scope for this system, e.g created or a component was added to it.
void	inserted(IntBag entities) Called after entities match an EntitySubscription.
protected void	removed(int entityId) Called if entity has gone out of scope of this system, e.g deleted or had one of it's components removed.
void	removed(IntBag entities) Called if entity has gone out of scope of this system, e.g deleted or had one of it's components removed.
protected void	setWorld(World world) Set the world this system works on.

Methods inherited from class com.artemis.BaseSystem

begin, checkProcessing, dispose, end, getWorld, initialize, isEnabled, process, processSystem, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

subscription

protected EntitySubscription subscription

Constructor Detail

BaseEntitySystem

public BaseEntitySystem()

BaseEntitySystem

public BaseEntitySystem(Aspect.Builder aspect)

Creates an entity system that uses the specified aspect as a matcher against entities.

Parameters:

aspect - to match against entities

Method Detail

setWorld

protected void setWorld(World world)

Description copied from class: BaseSystem

Set the world this system works on.

Overrides:

setWorld in class BaseSystem

Parameters:

world - the world to set

getSubscription

public EntitySubscription getSubscription()

Returns:

entity subscription backing this system.

inserted

public void inserted(IntBag entities)

Description copied from interface: EntitySubscription.SubscriptionListener

Called after entities match an EntitySubscription. Triggers right after a system finishes processing. Adding and immediately removing a component does not permanently change the composition and will prevent this method from being called. Not triggered for entities that have been destroyed immediately after being created (within a system).

Specified by:

inserted in interface EntitySubscription.SubscriptionListener

getEntityIds

public IntBag getEntityIds()

Gets the entities processed by this system. Do not delete entities from this bag - it is the live thing.

Returns:

System's entity ids, as matched by aspect.

inserted

protected void inserted(int entityId)

Called if entity has come into scope for this system, e.g created or a component was added to it. Triggers right after any system finishes processing. Adding and immediately removing a component does not count as a permanently change and will prevent this method from being called. Not triggered for entities that have been destroyed immediately after being created (within a system).

Parameters:

entityId - the entity that was added to this system

removed

public void removed(IntBag entities)

Called if entity has gone out of scope of this system, e.g deleted or had one of it's components removed.

Explicitly removed components are only retrievable at this point if annotated with DelayedComponentRemoval.

Deleted entities retain all their components - until all listeners have been informed.

Specified by:

removed in interface EntitySubscription.SubscriptionListener

Parameters:

entities - entities removed from this system.

removed

protected void removed(int entityId)

Called if entity has gone out of scope of this system, e.g deleted or had one of it's components removed.

Important note on accessing components: Using ComponentMapper.get(int) to retrieve a component is unsafe, unless: - You annotate the component with DelayedComponentRemoval. - World.isAlwaysDelayComponentRemoval() is enabled to make accessing all components safe, for a small performance hit.

ComponentMapper.has(int) always returns false, even for DelayedComponentRemoval components. Can trigger for entities that have been destroyed immediately after being created (within a system).

Parameters:

entityId - the entity that was removed from this system