com.artemis

Class AspectSubscriptionManager

java.lang.Object

com.artemis.BaseSystem

com.artemis.AspectSubscriptionManager

@SkipWire
public class AspectSubscriptionManager
extends BaseSystem

Manages all instances of EntitySubscription.

Entity subscriptions are automatically updated during World.process(). Any listeners are informed when entities are added or removed.

See Also:

EntitySubscription

Field Summary

Fields inherited from class com.artemis.BaseSystem

world

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AspectSubscriptionManager()

Method Summary

Modifier and Type	Method and Description
EntitySubscription	get(Aspect.Builder builder) Gets the entity subscription for the Aspect.
ImmutableBag<EntitySubscription>	getSubscriptions() Gets the active list of all current entity subscriptions.
protected void	processSystem() Process the system.
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, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

AspectSubscriptionManager

protected AspectSubscriptionManager()

Method Detail

processSystem

protected void processSystem()

Description copied from class: BaseSystem

Process the system.

Specified by:

processSystem in class BaseSystem

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

get

public EntitySubscription get(Aspect.Builder builder)

Gets the entity subscription for the Aspect. Subscriptions are only created once per aspect.

Be careful when calling this within BaseSystem.processSystem(). If the subscription does not exist yet, the newly created subscription will reflect all the chances made by the currently processing system, NOT the state before the system started processing. This might cause the system to behave differently when run the first time (as subsequent calls won't have this issue). See https://github.com/junkdog/artemis-odb/issues/551

Parameters:

builder - Aspect to match.

Returns:

EntitySubscription for aspect.

getSubscriptions

public ImmutableBag<EntitySubscription> getSubscriptions()

Gets the active list of all current entity subscriptions. Meant to assist in tooling/debugging.

Returns:

All active subscriptions.