com.artemis

Class WorldConfiguration

java.lang.Object

com.artemis.WorldConfiguration

public final class WorldConfiguration
extends Object

Constructor Summary

Constructors

Constructor and Description
WorldConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
int	expectedEntityCount()
WorldConfiguration	expectedEntityCount(int expectedEntityCount) Initializes array type containers with the value supplied.
int	maxRebuiltIndicesPerTick()
WorldConfiguration	maxRebuiltIndicesPerTick(int maxRebuiltIndicesPerTick) Maximum limit on how many active entity indices are rebuilt each time World.process() is invoked.
WorldConfiguration	register(Object o) Manually register object for injection by type.
WorldConfiguration	register(String name, Object o) Manually register object for injection by name.

Methods inherited from class java.lang.Object

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

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.

maxRebuiltIndicesPerTick

public int maxRebuiltIndicesPerTick()

maxRebuiltIndicesPerTick

public WorldConfiguration maxRebuiltIndicesPerTick(int maxRebuiltIndicesPerTick)

Maximum limit on how many active entity indices are rebuilt each time World.process() is invoked. An index is flagged as dirty whenever an Entity is removed or added to a system.

Parameters:

maxRebuiltIndicesPerTick - 0 or more.

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 and managers.

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 and managers.

Parameters:

name - unique identifier matching injection site name.

o - object to inject.

Returns:

This instance for chaining.