| Package | Description |
|---|---|
| com.artemis |
Core Artemis classes.
|
| com.artemis.managers |
Manager implementations.
|
| com.artemis.systems |
Entity systems.
|
| com.artemis.utils |
Helper classes.
|
| Modifier and Type | Method and Description |
|---|---|
Entity |
Entity.addComponent(Component component)
Deprecated.
See
edit() |
Entity |
Entity.addComponent(Component component,
ComponentType type)
Deprecated.
See
edit() |
Entity |
World.createEntity()
Create and return a new or reused entity instance.
|
Entity |
World.createEntity(ArchetypeBuilder.Archetype archetype)
Create and return an
EntityEdit wrapping a new or reused entity instance. |
Entity |
World.createEntity(UUID uuid)
Create and return a new or reused entity instance.
|
protected Entity |
EntityManager.createEntityInstance()
Create a new entity.
|
protected Entity |
EntityManager.createEntityInstance(ArchetypeBuilder.Archetype archetype)
Create a new entity based on the supplied archetype.
|
Entity |
EntityEdit.getEntity() |
protected Entity |
EntityManager.getEntity(int entityId)
Get a entity with this id.
|
Entity |
World.getEntity(int entityId)
Get a entity having the specified id.
|
Entity |
Entity.removeComponent(Class<? extends Component> type)
Deprecated.
See
edit() |
Entity |
Entity.removeComponent(Component component)
Deprecated.
See
edit() |
Entity |
Entity.removeComponent(ComponentType type)
Deprecated.
See
edit() |
| Modifier and Type | Method and Description |
|---|---|
ImmutableBag<Entity> |
EntitySystem.getActives()
Get all entities being processed by this system.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
ComponentManager.addComponent(Entity e,
ComponentType type,
Component component)
Adds the component of the given type to the entity.
|
protected void |
ComponentManager.addComponents(Entity e,
ArchetypeBuilder.Archetype archetype) |
void |
EntityManager.added(Entity e)
Adds the entity to this manager.
|
void |
EntityObserver.added(Entity e)
Called when an entity the observer is interested in is added.
|
void |
Manager.added(Entity e) |
void |
ComponentManager.added(Entity e) |
void |
EntitySystem.added(Entity e)
Call when an entity interesting to the system is added to the world.
|
void |
World.addEntity(Entity e)
Deprecated.
internally managed by artemis
|
void |
EntityObserver.changed(Entity e)
Called when an entity the observer is interested in has changed.
|
void |
Manager.changed(Entity e) |
void |
EntitySystem.changed(Entity e)
Call when an entity interesting to the system has changed in the world.
|
void |
World.changedEntity(Entity e)
Deprecated.
does nothing, internally tracked by artemis now.
|
protected void |
EntitySystem.check(Entity e)
Will check if the entity is of interest to this system.
|
protected <T extends Component> |
ComponentManager.create(Entity owner,
Class<T> componentClass) |
void |
EntityManager.deleted(Entity e)
Removes the entity from the manager, freeing it's id for new entities.
|
void |
EntityObserver.deleted(Entity e)
Called when an entity the observer is interested in is deleted.
|
void |
Manager.deleted(Entity e) |
void |
ComponentManager.deleted(Entity e) |
void |
EntitySystem.deleted(Entity e)
Call when an entity interesting to the system was deleted from the
world.
|
void |
World.deleteEntity(Entity e)
Deprecated.
Better invoke
deleteFromWorld() or EntityEdit.deleteEntity() |
void |
World.disable(Entity e)
Deprecated.
create your own components to track state.
|
void |
EntityManager.disabled(Entity e)
Sets the entity as disabled in the manager.
|
void |
EntityObserver.disabled(Entity e)
Deprecated.
create your own components to track state.
|
void |
Manager.disabled(Entity e) |
void |
EntitySystem.disabled(Entity e)
Call when an entity interesting to the system was disabled.
|
void |
World.enable(Entity e)
Deprecated.
create your own components to track state.
|
void |
EntityManager.enabled(Entity e)
Deprecated.
create your own components to track state.
|
void |
EntityObserver.enabled(Entity e)
Deprecated.
create your own components to track state.
|
void |
Manager.enabled(Entity e) |
void |
EntitySystem.enabled(Entity e)
Call when an entity interesting to the system was (re)enabled.
|
protected abstract void |
PackedComponent.forEntity(Entity e)
Sets the currently processed entity.
|
abstract A |
ComponentMapper.get(Entity e)
Fast but unsafe retrieval of a component for this entity.
|
abstract A |
ComponentMapper.get(Entity e,
boolean forceNewInstance)
Fast but unsafe retrieval of a component for this entity.
|
protected Component |
ComponentManager.getComponent(Entity e,
ComponentType type)
Get a component of an entity.
|
Bag<Component> |
ComponentManager.getComponentsFor(Entity e,
Bag<Component> fillBag)
Get all component associated with an entity.
|
protected int |
EntityManager.getIdentity(Entity e) |
abstract A |
ComponentMapper.getSafe(Entity e)
Fast and safe retrieval of a component for this entity.
|
abstract A |
ComponentMapper.getSafe(Entity e,
boolean forceNewInstance)
Fast and safe retrieval of a component for this entity.
|
abstract boolean |
ComponentMapper.has(Entity e)
Checks if the entity has this type of component.
|
protected void |
EntitySystem.inserted(Entity e)
Called if the system has received a entity it is interested in, e.g
created or a component was added to it.
|
boolean |
Aspect.isInterested(Entity e)
Returns whether this Aspect would accept the given Entity.
|
protected void |
ComponentManager.removeComponent(Entity e,
ComponentType type)
Removes the component of given type from the entity.
|
protected void |
EntitySystem.removed(Entity e)
Called if a entity was removed from this system, e.g deleted or had one
of it's components removed.
|
| Modifier and Type | Method and Description |
|---|---|
void |
EntityObserver.added(ImmutableBag<Entity> entities) |
void |
Manager.added(ImmutableBag<Entity> entities) |
void |
EntitySystem.added(ImmutableBag<Entity> entities) |
void |
EntityObserver.changed(ImmutableBag<Entity> entities) |
void |
Manager.changed(ImmutableBag<Entity> entities) |
void |
EntitySystem.changed(ImmutableBag<Entity> entities) |
void |
EntityObserver.deleted(ImmutableBag<Entity> entities) |
void |
Manager.deleted(ImmutableBag<Entity> entities) |
void |
EntitySystem.deleted(ImmutableBag<Entity> entities) |
protected abstract void |
EntitySystem.processEntities(ImmutableBag<Entity> entities)
Any implementing entity system must implement this method and the logic
to process the given entities of the system.
|
| Modifier and Type | Method and Description |
|---|---|
Entity |
TagManager.getEntity(String tag)
Get the entity tagged with the given tag.
|
Entity |
UuidEntityManager.getEntity(UUID uuid) |
| Modifier and Type | Method and Description |
|---|---|
ImmutableBag<Entity> |
GroupManager.getEntities(String group)
Get all entities that belong to the provided group.
|
ImmutableBag<Entity> |
PlayerManager.getEntitiesOfPlayer(String player)
Get all entities belonging to a player.
|
| Modifier and Type | Method and Description |
|---|---|
void |
GroupManager.add(Entity e,
String group)
Set the group of the entity.
|
void |
TagManager.deleted(Entity e)
If the entity gets deleted, remove the tag used by it.
|
void |
GroupManager.deleted(Entity e)
Removes the entity from all groups.
|
void |
PlayerManager.deleted(Entity e)
Deleted entities are removed from their player.
|
void |
UuidEntityManager.deleted(Entity e) |
ImmutableBag<String> |
GroupManager.getGroups(Entity e)
Get all groups the entity belongs to.
|
String |
PlayerManager.getPlayer(Entity e)
Get the player an entity is associated with.
|
UUID |
UuidEntityManager.getUuid(Entity e) |
boolean |
GroupManager.isInAnyGroup(Entity e)
Checks if the entity belongs to any group.
|
boolean |
GroupManager.isInGroup(Entity e,
String group)
Check if the entity is in the supplied group.
|
void |
TagManager.register(String tag,
Entity e)
Tag an entity.
|
void |
GroupManager.remove(Entity e,
String group)
Remove the entity from the specified group.
|
void |
GroupManager.removeFromAllGroups(Entity e)
Remove the entity from all groups.
|
void |
PlayerManager.removeFromPlayer(Entity e)
Remove the association of an entity with a player.
|
void |
PlayerManager.setPlayer(Entity e,
String player)
Associate the entity with the specified player.
|
void |
UuidEntityManager.setUuid(Entity e,
UUID newUuid) |
void |
UuidEntityManager.updatedUuid(Entity e,
UUID newUuid) |
| Modifier and Type | Method and Description |
|---|---|
protected abstract float |
DelayedEntityProcessingSystem.getRemainingDelay(Entity e)
Return the delay until this entity should be processed.
|
protected void |
DelayedEntityProcessingSystem.inserted(Entity e) |
protected abstract void |
IntervalEntityProcessingSystem.process(Entity e)
Process a entity this system is interested in.
|
protected abstract void |
EntityProcessingSystem.process(Entity e)
Process a entity this system is interested in.
|
protected abstract void |
DelayedEntityProcessingSystem.processDelta(Entity e,
float accumulatedDelta)
Process a entity this system is interested in.
|
protected abstract void |
DelayedEntityProcessingSystem.processExpired(Entity e) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
VoidEntitySystem.processEntities(ImmutableBag<Entity> entities) |
protected void |
IntervalEntityProcessingSystem.processEntities(ImmutableBag<Entity> entities) |
protected void |
DelayedEntityProcessingSystem.processEntities(ImmutableBag<Entity> entities) |
protected void |
EntityProcessingSystem.processEntities(ImmutableBag<Entity> entities) |
| Modifier and Type | Method and Description |
|---|---|
Entity |
EntityBuilder.build()
Assemble, add to world
|
Copyright © 2014. All Rights Reserved.