com.artemis

Class WorldConfiguration

java.lang.Object

com.artemis.WorldConfiguration

public final class WorldConfiguration
extends Object

Contains configuration for your world. Can be used for: - Adding Systems. - Adding Managers. - Registering Pojo to inject. - Registering custom dependency injector.

See Also:

allows convenient creation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASPECT_SUBSCRIPTION_MANAGER_IDX
static int	COMPONENT_MANAGER_IDX
static int	ENTITY_MANAGER_IDX
protected int	expectedEntityCount
protected Map<String,Object>	injectables
protected Injector	injector
protected SystemInvocationStrategy	invocationStrategy

Constructor Summary

Constructors

Constructor and Description
WorldConfiguration()

Method Summary

Modifier and Type	Method and Description
int	expectedEntityCount()
WorldConfiguration	expectedEntityCount(int expectedEntityCount) Initializes array type containers with the value supplied.
boolean	isAlwaysDelayComponentRemoval() Delay component removal until all subscriptions have been notified.
WorldConfiguration	register(Object o) Manually register object for injection by type.
WorldConfiguration	register(String name, Object o) Manually register object for injection by name.
void	setAlwaysDelayComponentRemoval(boolean value) Delay component removal until all subscriptions have been notified.
WorldConfiguration	setInjector(Injector injector) Set Injector to handle all dependency injections.
WorldConfiguration	setInvocationStrategy(SystemInvocationStrategy invocationStrategy) Set strategy for invoking systems on World.process().
WorldConfiguration	setSystem(Class<? extends BaseSystem> system) Adds a system to this world that will be processed by World.process().
<T extends BaseSystem> WorldConfiguration	setSystem(T system) Will add a system to this world.

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_MANAGER_IDX

public static final int COMPONENT_MANAGER_IDX

See Also:

Constant Field Values

ENTITY_MANAGER_IDX

public static final int ENTITY_MANAGER_IDX

See Also:

Constant Field Values

ASPECT_SUBSCRIPTION_MANAGER_IDX

public static final int ASPECT_SUBSCRIPTION_MANAGER_IDX

See Also:

Constant Field Values

expectedEntityCount

protected int expectedEntityCount

injectables

protected Map<String,Object> injectables

injector

protected Injector injector

invocationStrategy

protected SystemInvocationStrategy invocationStrategy

Constructor Detail

WorldConfiguration

public WorldConfiguration()

Method Detail

expectedEntityCount

public int expectedEntityCount()

expectedEntityCount

public WorldConfiguration expectedEntityCount(int expectedEntityCount)

Initializes array type containers with the value supplied.

Parameters:

expectedEntityCount - count of expected entities.

Returns:

This instance for chaining.

setInjector

public WorldConfiguration setInjector(Injector injector)

Set Injector to handle all dependency injections.

Parameters:

injector - Injector to handle dependency injections.

Returns:

This instance for chaining.

setInvocationStrategy

public WorldConfiguration setInvocationStrategy(SystemInvocationStrategy invocationStrategy)

Set strategy for invoking systems on World.process().

Parameters:

invocationStrategy - Strategy that will invoke systems.

Returns:

This instance for chaining.

register

public WorldConfiguration register(Object o)

Manually register object for injection by type. Explicitly annotate to be injected fields with @Wire. A class level @Wire annotation is not enough. Since objects are injected by type, this method is limited to one object per type. Use register(String, Object) to register multiple objects of the same type. Not required for systems.

Parameters:

o - object to inject.

Returns:

This instance for chaining.

register

public WorldConfiguration register(String name,
                                   Object o)

Manually register object for injection by name. Explicitly annotate to be injected fields with @Wire(name="myName"). A class level @Wire annotation is not enough. Not required for systems.

Parameters:

name - unique identifier matching injection site name.

o - object to inject.

Returns:

This instance for chaining.

setSystem

public WorldConfiguration setSystem(Class<? extends BaseSystem> system)

Adds a system to this world that will be processed by World.process().

Parameters:

system - the system to add

Returns:

the added system

setSystem

public <T extends BaseSystem> WorldConfiguration setSystem(T system)

Will add a system to this world.

Type Parameters:

T - the system class type

Parameters:

system - the system to add

Returns:

the added system

isAlwaysDelayComponentRemoval

public boolean isAlwaysDelayComponentRemoval()

Delay component removal until all subscriptions have been notified. Extends the lifecycle of ALL component types, ensuring removed instances are retrievable until all listeners have been notified - regardless of removal method.

setAlwaysDelayComponentRemoval

public void setAlwaysDelayComponentRemoval(boolean value)

Delay component removal until all subscriptions have been notified. Extends the lifecycle of ALL component types, ensuring removed instances are retrievable until all listeners have been notified - regardless of removal method. Has a slight performance cost.

Parameters:

value - When true, component removal for all components will be delayed.