com.artemis

Class EntityEdit

java.lang.Object

com.artemis.EntityEdit

public final class EntityEdit
extends Object

Entity mutator.

Provides a fast albeit verbose way to perform batch changes to entities.

BaseSystem, EntitySubscription.SubscriptionListener are informed of changes only after the current system has done processing and the next system is about to be invoked. This removes the need for systems to defend their subscription lists and allows for cleaner code and better performance.

Alternatives to edit entities.

- ComponentMapper is great for concrete changes BaseComponentMapper.create(Entity). Best choice for parameterizing pooled components. - EntityBuilder Convenient entity creation. Not useful when pooling. - EntityTransmuterFactory Fastest but rigid way of changing entity component compositions. - Archetype Fastest, low level, no parameterized components.

Method Summary

Modifier and Type	Method and Description
EntityEdit	add(Component component) Add a component to this entity.
EntityEdit	add(Component component, ComponentType type) Faster adding of components into the entity.
<T extends Component> T	create(Class<T> componentKlazz) Create new instance of component.
Entity	getEntity() Get target entity of entity edits.
int	getEntityId() Get target entity id of entity edits.
EntityEdit	remove(Class<? extends Component> type) Remove component by its type.
EntityEdit	remove(Component component) Removes the component from this entity.
EntityEdit	remove(ComponentType type) Removal of components from a entity.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public <T extends Component> T create(Class<T> componentKlazz)

Create new instance of component.

if exists, replaces and retires old component!

Parameters:

componentKlazz - Class to create.

Returns:

Newly instanced component.

add

public EntityEdit add(Component component)

Add a component to this entity.

Parameters:

component - the component to add to this entity. Does not support packed or pooled.

Returns:

this EntityEdit for chaining

See Also:

create(Class)

add

public EntityEdit add(Component component,
                      ComponentType type)

Faster adding of components into the entity.

Not necessary to use this, but in some cases you might need the extra performance.

Parameters:

component - the component to add. Does not support packed or pooled.

type - the type of the component

Returns:

this EntityEdit for chaining

See Also:

create(Class)

getEntity

public Entity getEntity()

Get target entity of entity edits.

Returns:

Entity this EntityEdit operates on.

getEntityId

public int getEntityId()

Get target entity id of entity edits.

Returns:

Entity id this EntityEdit operates on.

remove

public EntityEdit remove(Component component)

Removes the component from this entity.

Parameters:

component - the component to remove from this entity.

Returns:

this EntityEdit for chaining

remove

public EntityEdit remove(ComponentType type)

Removal of components from a entity.

Faster than remove(Class).

Parameters:

type - the type of component to remove from this entity

Returns:

this EntityEdit for chaining

remove

public EntityEdit remove(Class<? extends Component> type)

Remove component by its type.

Parameters:

type - the class type of component to remove from this entity

Returns:

this EntityEdit for chaining

toString

public String toString()

Overrides:

toString in class Object