Entity (artemis-odb 2.2.0 API)

java.lang.Object
- com.artemis.Entity

```
public final class Entity
extends Object
```
The entity convenience class.
In artemis-odb, entities are represented by an int for performance reasons. For convenience, Entity class is also supported.
Entity instances and ids get recycled. It is not safe to retain a reference to an Entity after it has been deleted from the world.
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, Adrian Papari

Constructor Summary

Constructors
Modifier Constructor and Description

protected Entity(World world, int id)
Creates a new Entity instance in the given world.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteFromWorld()` Delete the entity from the world.
`EntityEdit`	`edit()` Get entity editor.
`boolean`	`equals(Entity o)` id equality
`boolean`	`equals(Object o)` id equality
`<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 BitVector`	`getComponentBits()` Returns a BitVector 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.
`World`	`getWorld()` Returns the world this entity belongs to.
`int`	`hashCode()`
`boolean`	`isActive()` Checks if the entity has been added to the world and has not been deleted from it.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, 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
- Method Detail
  - getId
```
public int getId()
```
    The internal id for this entity within the framework. Id is zero or greater.
    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, a positive integer.
  - getComponentBits
```
protected BitVector getComponentBits()
```
    Returns a BitVector instance containing bits of the components the entity possesses.
    
    Returns:
    
    a BitVector containing the entities component bits
  - edit
```
public EntityEdit edit()
```
    Get entity editor.
    
    Returns:
    
    a fast albeit verbose editor to perform batch changes to entities.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
  - getComponent
```
public Component getComponent(ComponentType type)
```
    Retrieves component from this entity.
    Minimize usage of this. Use ComponentMapper instead.
    
    Parameters:
    
    type - in order to retrieve the component fast you must provide a ComponentType instance for the expected component
    
    Returns:
    
    component that matches, or null if none is found
  - getComponent
```
public <T extends Component> T getComponent(Class<T> type)
```
    Slower retrieval of components from this entity.
    Minimize usage of this. Use ComponentMapper instead.
    
    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
  - deleteFromWorld
```
public void deleteFromWorld()
```
    Delete the entity from the world. The entity is considered to be in a final state once invoked; adding or removing components from an entity scheduled for deletion will likely throw exceptions.
  - getWorld
```
public World getWorld()
```
    Returns the world this entity belongs to.
    
    Returns:
    
    world of entity.
  - getCompositionId
```
public int getCompositionId()
```
    Returns:
    
    unique identifier for entities with this specific component configuration.
  - equals
```
public boolean equals(Object o)
```
    id equality
    
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(Entity o)
```
    id equality
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Method Detail

getId

getComponentBits

edit

toString

isActive

getComponent

getComponent

getComponents

deleteFromWorld

getWorld

getCompositionId

equals

equals

hashCode