World (artemis-odb 2.2.0 API)

java.lang.Object
- com.artemis.World

```
public class World
extends Object
```
The primary instance for the framework.
It contains all the systems. You must use this to create, delete and retrieve entities. It is also important to set the delta each game loop iteration, and initialize before game loop.

Author:

Arni Arent, junkdog

Field Summary

Fields
Modifier and Type Field and Description

float delta
The time passed since the last update.

Fields
Modifier and Type	Field and Description
`float`	`delta` The time passed since the last update.

Constructor Summary

Constructors
Constructor and Description

World()
Creates a world without custom systems.

World(WorldConfiguration configuration)
Creates a new world.

Constructors
Constructor and Description
`World()` Creates a world without custom systems.
`World(WorldConfiguration configuration)` Creates a new world.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compositionId(int entityId)` Gets the `composition id` uniquely identifying the component composition of an entity.
`int`	`create()` Create and return a new or reused entity id.
`int`	`create(Archetype archetype)` Create and return an `Entity` wrapping a new or reused entity instance.
`Entity`	`createEntity()` Create and return a new or reused entity instance.
`Entity`	`createEntity(Archetype archetype)` Create and return an `Entity` wrapping a new or reused entity instance.
`void`	`delete(int entityId)` Delete the entity from the world.
`void`	`deleteEntity(Entity e)` Delete the entity from the world.
`void`	`dispose()` Disposes all systems.
`EntityEdit`	`edit(int entityId)` Get entity editor for entity.
`AspectSubscriptionManager`	`getAspectSubscriptionManager()` Returns the manager responsible for creating and maintaining `subscriptions` in the world.
`ComponentManager`	`getComponentManager()` Returns a manager that takes care of all the components in the world.
`float`	`getDelta()` Time since last game loop.
`Entity`	`getEntity(int entityId)` Get entity with the specified id.
`EntityManager`	`getEntityManager()` Returns a manager that takes care of all the entities in the world.
`Injector`	`getInjector()`
`<T extends SystemInvocationStrategy> T`	`getInvocationStrategy()`
`<T extends Component> ComponentMapper<T>`	`getMapper(Class<T> type)` Retrieves a ComponentMapper instance for fast retrieval of components from entities.
`<T> T`	`getRegistered(Class<T> type)`
`<T> T`	`getRegistered(String name)`
`<T extends BaseSystem> T`	`getSystem(Class<T> type)` Retrieve a system for specified system type.
`ImmutableBag<BaseSystem>`	`getSystems()` Gives you all the systems in this world for possible iteration.
`void`	`inject(Object target)` Inject dependencies on object.
`void`	`inject(Object target, boolean failIfNotInjectable)` Inject dependencies on object.
`boolean`	`isAlwaysDelayComponentRemoval()` When true, component removal is delayed for all components until all subscriptions have been notified.
`void`	`process()` Process all non-passive systems.
`void`	`setDelta(float delta)` You must specify the delta for the game here.
`protected void`	`setInvocationStrategy(SystemInvocationStrategy invocationStrategy)` Set strategy for invoking systems on `process()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - delta
```
public float delta
```
    The time passed since the last update.
- Constructor Detail
  - World
```
public World()
```
    Creates a world without custom systems.
    EntityManager, ComponentManager and AspectSubscriptionManager are available by default.
    Why are you using this? Use World(WorldConfiguration) to create a world with your own systems.
  - World
```
public World(WorldConfiguration configuration)
```
    Creates a new world.
    EntityManager, ComponentManager and AspectSubscriptionManager are available by default, on top of your own systems.
    
    See Also:
    
    WorldConfigurationBuilder, WorldConfiguration
- Method Detail
  - inject
```
public void inject(Object target)
```
    Inject dependencies on object.
    Immediately perform dependency injection on the target, even if the target isn't of an Artemis class.
    If you want to specify nonstandard dependencies to inject, use WorldConfiguration.register(String, Object) instead, or configure an Injector
    If you want a non-throwing alternative, use inject(Object, boolean)
    
    Parameters:
    
    target - Object to inject into. throws MundaneWireException if target is annotated with SkipWire
    
    See Also:
    
    for more details about dependency injection., inject(Object, boolean)
  - inject
```
public void inject(Object target,
                   boolean failIfNotInjectable)
```
    Inject dependencies on object.
    Will not if it is annotated with Wire.
    If you want to specify nonstandard dependencies to inject, use WorldConfiguration.register(String, Object) instead, or configure an Injector.
    
    Parameters:
    
    target - Object to inject into.
    
    failIfNotInjectable - if true, this method will throws MundaneWireException if target is annotated with SkipWire and failIfNotInjectable is true
    
    See Also:
    
    for more details about dependency injection., inject(Object)
  - getRegistered
```
public <T> T getRegistered(String name)
```
  - getRegistered
```
public <T> T getRegistered(Class<T> type)
```
  - dispose
```
public void dispose()
```
    Disposes all systems. Only necessary if either need to free managed resources upon bringing the world to an end.
    
    Throws:
    
    ArtemisMultiException - if any system throws an exception.
  - edit
```
public EntityEdit edit(int entityId)
```
    Get entity editor for entity.
    
    Parameters:
    
    entityId - entity to fetch editor for.
    
    Returns:
    
    a fast albeit verbose editor to perform batch changes to entities.
  - compositionId
```
public int compositionId(int entityId)
```
    Gets the composition id uniquely identifying the component composition of an entity. Each composition identity maps to one unique BitVector.
    
    Parameters:
    
    entityId - Entity for which to get the composition id
    
    Returns:
    
    composition identity of entity
  - getEntityManager
```
public EntityManager getEntityManager()
```
    Returns a manager that takes care of all the entities in the world.
    
    Returns:
    
    entity manager
  - getComponentManager
```
public ComponentManager getComponentManager()
```
    Returns a manager that takes care of all the components in the world.
    
    Returns:
    
    component manager
  - getAspectSubscriptionManager
```
public AspectSubscriptionManager getAspectSubscriptionManager()
```
    Returns the manager responsible for creating and maintaining subscriptions in the world.
    
    Returns:
    
    aspect subscription manager
  - getDelta
```
public float getDelta()
```
    Time since last game loop.
    
    Returns:
    
    delta time since last game loop
  - setDelta
```
public void setDelta(float delta)
```
    You must specify the delta for the game here.
    
    Parameters:
    
    delta - time since last game loop
  - deleteEntity
```
public void deleteEntity(Entity e)
```
    Delete the entity from the world.
    
    Parameters:
    
    e - the entity to delete
    
    See Also:
    
    recommended alternative.
  - delete
```
public void delete(int entityId)
```
    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.
    
    Parameters:
    
    entityId - the entity to delete
  - createEntity
```
public Entity createEntity()
```
    Create and return a new or reused entity instance. Entity is automatically added to the world.
    
    Returns:
    
    entity
    
    See Also:
    
    recommended alternative.
  - create
```
public int create()
```
    Create and return a new or reused entity id. Entity is automatically added to the world.
    
    Returns:
    
    assigned entity id, where id >= 0.
  - createEntity
```
public Entity createEntity(Archetype archetype)
```
    Create and return an Entity wrapping a new or reused entity instance. Entity is automatically added to the world. Use Entity.edit() to set up your newly created entity. You can also create entities using:
    - EntityBuilder Convenient entity creation. Not useful when pooling.
    - Archetype Fastest, low level, no parameterized components.
    - Serialization, with a simple prefab-like class to parameterize the entities.
    Returns:
    
    entity
    
    See Also:
    
    recommended alternative.
  - create
```
public int create(Archetype archetype)
```
    Create and return an Entity wrapping a new or reused entity instance. Entity is automatically added to the world. Use Entity.edit() to set up your newly created entity. You can also create entities using: - EntityBuilder Convenient entity creation. Not useful when pooling. - Archetype Fastest, low level, no parameterized components.
    
    Returns:
    
    assigned entity id
  - getEntity
```
public Entity getEntity(int entityId)
```
    Get entity with the specified id. Resolves entity id to the unique entity instance. This method may return an entity even if it isn't active in the world. Make sure to not retain id's of deleted entities.
    
    Parameters:
    
    entityId - the entities id
    
    Returns:
    
    the specific entity
  - getSystems
```
public ImmutableBag<BaseSystem> getSystems()
```
    Gives you all the systems in this world for possible iteration.
    
    Returns:
    
    all entity systems in world
  - getSystem
```
public <T extends BaseSystem> T getSystem(Class<T> type)
```
    Retrieve a system for specified system type.
    
    Type Parameters:
    
    T - the class type of system
    
    Parameters:
    
    type - type of system
    
    Returns:
    
    instance of the system in this world
  - setInvocationStrategy
```
protected void setInvocationStrategy(SystemInvocationStrategy invocationStrategy)
```
    Set strategy for invoking systems on process().
  - process
```
public void process()
```
    Process all non-passive systems.
    
    See Also:
    
    to control and extend how systems are invoked.
  - getMapper
```
public <T extends Component> ComponentMapper<T> getMapper(Class<T> type)
```
    Retrieves a ComponentMapper instance for fast retrieval of components from entities. Odb automatically injects component mappers into systems, calling this method is usually not required.,
    
    Type Parameters:
    
    T - class type of the component
    
    Parameters:
    
    type - type of component to get mapper for
    
    Returns:
    
    mapper for specified component type
  - getInjector
```
public Injector getInjector()
```
    Returns:
    
    Injector responsible for dependency injection.
  - getInvocationStrategy
```
public <T extends SystemInvocationStrategy> T getInvocationStrategy()
```
    Returns:
    
    Strategy used for invoking systems during process().
  - isAlwaysDelayComponentRemoval
```
public boolean isAlwaysDelayComponentRemoval()
```
    When true, component removal is delayed for all components until all subscriptions have been notified.
    
    See Also:
    
    WorldConfiguration.setAlwaysDelayComponentRemoval(boolean), WorldConfigurationBuilder.alwaysDelayComponentRemoval(boolean)

Class World

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

delta

Constructor Detail

World

World

Method Detail

inject

inject

getRegistered

getRegistered

dispose

edit

compositionId

getEntityManager

getComponentManager

getAspectSubscriptionManager

getDelta

setDelta

deleteEntity

delete

createEntity

create

createEntity

create

getEntity

getSystems

getSystem

setInvocationStrategy

process

getMapper

getInjector

getInvocationStrategy

isAlwaysDelayComponentRemoval