com.artemis

Class EntityTransmuter

java.lang.Object

com.artemis.EntityTransmuter

public final class EntityTransmuter
extends Object

Fastest way of changing entity component compositions. Primarily useful when bootstrapping entities over several different systems or when dealing with many entities at the same time (light particle systems etc).

Given a set of component additions/removals: for each encountered compositionId, cache the calculated new compositionId. This extends the performance benefits introduced with Archetypes in 0.7.0 to carry over to existing entities.

See Also:

EntityTransmuterFactory

Constructor Summary

Constructors

Constructor and Description
EntityTransmuter(World world, Aspect.Builder aspect)

Method Summary

Modifier and Type	Method and Description
String	toString()
void	transmute(Entity e) Apply on target entity.
void	transmute(int entityId) Apply on target entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityTransmuter

public EntityTransmuter(World world,
                        Aspect.Builder aspect)

Method Detail

transmute

public void transmute(int entityId)

Apply on target entity. Does nothing if entity has been scheduled for deletion.

Transmuter will add components by replacing and retire pre-existing components.

Parameters:

entityId - target entity id

transmute

public void transmute(Entity e)

Apply on target entity. Transmuter will add components by replacing and retire pre-existing components.

Parameters:

e - target entity.

toString

public String toString()

Overrides:

toString in class Object