com.artemis

Class EntitySubscription

java.lang.Object

com.artemis.EntitySubscription

public class EntitySubscription
extends Object

Maintains the list of entities matched by an aspect. Entity subscriptions are automatically updated during World.process(). Any listeners are informed when entities are added or removed. Be careful! Subscriptions do not immediately reflect changes by the active system. Subscriptions only guarantee contained entities matched before the current system started processing. Access entities and components defensively.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntitySubscription.SubscriptionExtra
static interface	EntitySubscription.SubscriptionListener This interfaces reports entities inserted or removed when matched against their EntitySubscription

Method Summary

Modifier and Type	Method and Description
void	addSubscriptionListener(EntitySubscription.SubscriptionListener listener) Add listener interested in changes to the subscription.
BitVector	getActiveEntityIds() Returns the bitset tracking all matched entities.
Aspect	getAspect()
Aspect.Builder	getAspectBuilder()
IntBag	getEntities() Returns a reference to the bag holding all matched entities.
void	removeSubscriptionListener(EntitySubscription.SubscriptionListener listener) Remove previously registered listener.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getEntities

public IntBag getEntities()

Returns a reference to the bag holding all matched entities.

Warning: Never remove elements from the bag, as this will lead to undefined behavior.

Returns:

View of all active entities.

getActiveEntityIds

public BitVector getActiveEntityIds()

Returns the bitset tracking all matched entities.

Warning: Never toggle bits in the bitset, as this may lead to erroneously added or removed entities.

Returns:

View of all active entities.

getAspect

public Aspect getAspect()

Returns:

aspect used for matching entities to subscription.

getAspectBuilder

public Aspect.Builder getAspectBuilder()

Returns:

aspect builder used for matching entities to subscription.

addSubscriptionListener

public void addSubscriptionListener(EntitySubscription.SubscriptionListener listener)

Add listener interested in changes to the subscription.

Parameters:

listener - listener to add.

removeSubscriptionListener

public void removeSubscriptionListener(EntitySubscription.SubscriptionListener listener)

Remove previously registered listener.

Parameters:

listener - listener to remove.

toString

public String toString()

Overrides:

toString in class Object