com.artemis

Class ComponentMapper<A extends Component>

java.lang.Object

com.artemis.BaseComponentMapper<A>

com.artemis.ComponentMapper<A>

Type Parameters:

A - Component type to map.

public class ComponentMapper<A extends Component>
extends BaseComponentMapper<A>

Provide high performance component access and mutation from within a System.

This is the recommended way to mutate composition and access components. Component Mappers are as fast as Transmuters.

See Also:

for a list of alternate ways to alter composition and access components.

Field Summary

Fields inherited from class com.artemis.BaseComponentMapper

type

Constructor Summary

Constructors

Constructor and Description
ComponentMapper(Class<A> type, World world)

Method Summary

Modifier and Type	Method and Description
A	create(int entityId) Create component for this entity.
A	get(int entityId) Fast but unsafe retrieval of a component for this entity.
boolean	has(int entityId) Checks if the entity has this type of component.
A	internalCreate(int entityId)
protected void	internalRemove(int entityId)
void	remove(int entityId) Schedule component for removal.

Methods inherited from class com.artemis.BaseComponentMapper

create, get, getFor, getSafe, getSafe, getType, has, remove, set, set, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentMapper

public ComponentMapper(Class<A> type,
                       World world)

Method Detail

get

public A get(int entityId)
      throws ArrayIndexOutOfBoundsException

Fast but unsafe retrieval of a component for this entity.

This method trades performance for safety!

Might return null, throw ArrayIndexOutOfBoundsException or a partially recycled component if called on in-system removed components.

Only exception are components marked with DelayedComponentRemoval, when calling this method from within a subscription listener.

Specified by:

get in class BaseComponentMapper<A extends Component>

Parameters:

entityId - the entity that should possess the component

Returns:

the instance of the component.

Throws:

ArrayIndexOutOfBoundsException

has

public boolean has(int entityId)

Checks if the entity has this type of component.

Removed components flagged with DelayedComponentRemoval will report false immediately after removal but will still be available using get(int).

Specified by:

has in class BaseComponentMapper<A extends Component>

Parameters:

entityId - the id of entity to check

Returns:

true if the entity has this component type, false if it doesn't (or if it is scheduled for delayed removal).

remove

public void remove(int entityId)

Schedule component for removal.

Components annotated with DelayedComponentRemoval (or all components if World.isAlwaysDelayComponentRemoval() mode is active) are removed after the system finishes processing and all subscribers have been called. However, has(int) will immediately return false as if it was removed!

Non-delayed components are removed immediately. The component reference becomes invalid and should be discarded. Immediate following calls to has(int) will return false, get(int) will return null. AspectSubscriptions will reflect the changes only AFTER the system finishes processing.

Does nothing if already removed.

Specified by:

remove in class BaseComponentMapper<A extends Component>

Parameters:

entityId -

internalRemove

protected void internalRemove(int entityId)

Specified by:

internalRemove in class BaseComponentMapper<A extends Component>

create

public A create(int entityId)

Create component for this entity. Avoids creation if component exists.

Specified by:

create in class BaseComponentMapper<A extends Component>

Parameters:

entityId - the entity that should possess the component

Returns:

the instance of the component.

internalCreate

public A internalCreate(int entityId)

Specified by:

internalCreate in class BaseComponentMapper<A extends Component>