com.artemis.link

Class EntityLinkManager

java.lang.Object

com.artemis.BaseSystem

com.artemis.BaseEntitySystem

com.artemis.link.EntityLinkManager

All Implemented Interfaces:

EntitySubscription.SubscriptionListener

@SkipWire
public class EntityLinkManager
extends BaseEntitySystem

Maintains relationships between entities.

This system is optional and must be manually registered with the world instance.

See Also:

EntityId

Field Summary

Fields inherited from class com.artemis.BaseEntitySystem

subscription

Fields inherited from class com.artemis.BaseSystem

world

Constructor Summary

Constructors

Constructor and Description
EntityLinkManager() Processes all fields, even if they don't have a LinkListener.
EntityLinkManager(boolean processSitesEvenIfNoListener, boolean fireEventsOnRegistration)

Method Summary

Modifier and Type	Method and Description
protected void	initialize() Override to implement code that gets executed when systems are initialized.
protected void	processSystem() Process the system.
void	register(Class<? extends Component> component, LinkListener listener) Injects and associates the listener with the component.
void	register(Class<? extends Component> component, String field, LinkListener listener) Injects and associates the listener with a specific field for a given component type.

Methods inherited from class com.artemis.BaseEntitySystem

getEntityIds, getSubscription, inserted, inserted, removed, removed, setWorld

Methods inherited from class com.artemis.BaseSystem

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityLinkManager

public EntityLinkManager(boolean processSitesEvenIfNoListener,
                         boolean fireEventsOnRegistration)

Parameters:

processSitesEvenIfNoListener - If true, only act on fields with an attached LinkListener.

fireEventsOnRegistration - If true,

EntityLinkManager

public EntityLinkManager()

Processes all fields, even if they don't have a LinkListener. LinkListener events will be fired when the listener is registered.

Method Detail

initialize

protected void initialize()

Description copied from class: BaseSystem

Override to implement code that gets executed when systems are initialized. Note that artemis native types like systems, factories and component mappers are automatically injected by artemis.

Overrides:

initialize in class BaseSystem

processSystem

protected void processSystem()

Description copied from class: BaseSystem

Process the system.

Specified by:

processSystem in class BaseSystem

register

public void register(Class<? extends Component> component,
                     LinkListener listener)

Injects and associates the listener with the component. This method is only recommended if only a single field references entities, or if all entity fields are of the same type.

Each ComponentType::Field pair can only have one LinkListener

Parameters:

component - component type associated with listener

listener - link listener

register

public void register(Class<? extends Component> component,
                     String field,
                     LinkListener listener)

Injects and associates the listener with a specific field for a given component type.

Each ComponentType::Field pair can only have one LinkListener

Parameters:

component - component type associated with listener

field - target field for listener

listener - link listener