com.artemis

Class Entity

java.lang.Object

com.artemis.Entity

public final class Entity
extends Object

The entity class.

Cannot be instantiated outside the framework, you must create new entities using World. The world creates entities via it's entity manager.

Author:

Arni Arent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Entity(World world, int id) Creates a new Entity instance in the given world.
protected	Entity(World world, int id, UUID uuid) Creates a new Entity instance in the given world.

Method Summary

Methods

Modifier and Type	Method and Description
Entity	addComponent(Component component) Deprecated. See edit()
Entity	addComponent(Component component, ComponentType type) Deprecated. See edit()
void	addToWorld() Deprecated. Automatically managed.
void	changedInWorld() Deprecated. Automatically managed.
<T extends Component> T	createComponent(Class<T> componentKlazz) Deprecated. See edit()
void	deleteFromWorld() Delete this entity from the world.
void	disable() Deprecated. create your own components to track state.
EntityEdit	edit()
void	enable() Deprecated. create your own components to track state.
<T extends Component> T	getComponent(Class<T> type) Slower retrieval of components from this entity.
Component	getComponent(ComponentType type) Retrieves component from this entity.
protected BitSet	getComponentBits() Returns a BitSet instance containing bits of the components the entity possesses.
Bag<Component>	getComponents(Bag<Component> fillBag) Returns a bag of all components this entity has.
int	getCompositionId()
int	getId() The internal id for this entity within the framework.
UUID	getUuid() Get the UUID for this entity.
World	getWorld() Returns the world this entity belongs to.
boolean	isActive() Checks if the entity has been added to the world and has not been deleted from it.
boolean	isEnabled() Deprecated. use components to implement state instead.
Entity	removeComponent(Class<? extends Component> type) Deprecated. See edit()
Entity	removeComponent(Component component) Deprecated. See edit()
Entity	removeComponent(ComponentType type) Deprecated. See edit()
void	setUuid(UUID uuid)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

protected Entity(World world,
      int id)

Creates a new Entity instance in the given world.

This will only be called by the world via it's entity manager, and not directly by the user, as the world handles creation of entities.

Parameters:

world - the world to create the entity in

id - the id to set

Entity

protected Entity(World world,
      int id,
      UUID uuid)

Creates a new Entity instance in the given world.

This will only be called by the world via it's entity manager, and not directly by the user, as the world handles creation of entities.

Parameters:

world - the world to create the entity in

id - the id to set

uuid - the UUID to set

Method Detail

getId

public int getId()

The internal id for this entity within the framework.

No other entity will have the same ID, but ID's are however reused so another entity may acquire this ID if the previous entity was deleted.

Returns:

id of the entity

getComponentBits

protected BitSet getComponentBits()

Returns a BitSet instance containing bits of the components the entity possesses.

Returns:

a BitSet containing the entities component bits

edit

public EntityEdit edit()

toString

public String toString()

Overrides:

toString in class Object

createComponent

@Deprecated
public <T extends Component> T createComponent(Class<T> componentKlazz)

Deprecated. See edit()

addComponent

@Deprecated
public Entity addComponent(Component component)

Deprecated. See edit()

addComponent

@Deprecated
public Entity addComponent(Component component,
                             ComponentType type)

Deprecated. See edit()

removeComponent

@Deprecated
public Entity removeComponent(Component component)

Deprecated. See edit()

removeComponent

@Deprecated
public Entity removeComponent(ComponentType type)

Deprecated. See edit()

removeComponent

@Deprecated
public Entity removeComponent(Class<? extends Component> type)

Deprecated. See edit()

isActive

public boolean isActive()

Checks if the entity has been added to the world and has not been deleted from it.

If the entity has been disabled this will still return true.

Returns:

true if it's active

isEnabled

@Deprecated
public boolean isEnabled()

Deprecated. use components to implement state instead.

Will check if the entity is enabled in the world.

By default all entities that are added to world are enabled, this will only return false if an entity has been explicitly disabled.

Returns:

true if it's enabled

getComponent

public Component getComponent(ComponentType type)

Retrieves component from this entity.

It will provide good performance. But the recommended way to retrieve components from an entity is using the ComponentMapper.

Parameters:

type - in order to retrieve the component fast you must provide a ComponentType instance for the expected component

Returns:

getComponent

public <T extends Component> T getComponent(Class<T> type)

Slower retrieval of components from this entity.

Minimize usage of this, but is fine to use e.g. when creating new entities and setting data in components.

Type Parameters:

T - the expected return component class type

Parameters:

type - the expected return component class type

Returns:

component that matches, or null if none is found

getComponents

public Bag<Component> getComponents(Bag<Component> fillBag)

Returns a bag of all components this entity has.

You need to reset the bag yourself if you intend to fill it more than once.

Parameters:

fillBag - the bag to put the components into

Returns:

the fillBag containing the components

addToWorld

@Deprecated
public void addToWorld()

Deprecated. Automatically managed.

changedInWorld

@Deprecated
public void changedInWorld()

Deprecated. Automatically managed.

deleteFromWorld

public void deleteFromWorld()

Delete this entity from the world.

enable

@Deprecated
public void enable()

Deprecated. create your own components to track state.

(Re)enable the entity in the world, after it having being disabled.

Won't do anything unless it was already disabled.

disable

@Deprecated
public void disable()

Deprecated. create your own components to track state.

Disable the entity from being processed.

Won't delete it, it will continue to exist but won't get processed.

getUuid

public UUID getUuid()

Get the UUID for this entity.

This UUID is unique per entity (re-used entities get a new UUID).

Returns:

uuid instance for this entity

setUuid

public void setUuid(UUID uuid)

getWorld

public World getWorld()

Returns the world this entity belongs to.

Returns:

world of entity

getCompositionId

public int getCompositionId()