com.artemis

Class WorldConfigurationBuilder

java.lang.Object

com.artemis.WorldConfigurationBuilder

public class WorldConfigurationBuilder
extends Object

World builder.

Allows convenient var-arg addition of systems, managers. Supports plugins.

Author:

Daan van Yperen

See Also:

WorldConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorldConfigurationBuilder.Priority Guideline constants for priority, higher values has more priority.

Constructor Summary

Constructors

Constructor and Description
WorldConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
WorldConfigurationBuilder	alwaysDelayComponentRemoval(boolean value) Delay component removal until all subscriptions have been notified.
WorldConfiguration	build() Assemble world with systems.
WorldConfigurationBuilder	dependsOn(Class... types) Specify dependency on systems/plugins.
WorldConfigurationBuilder	dependsOn(int priority, Class... types) Specify dependency on systems/plugins.
protected void	dependsOnSystem(int priority, Class<? extends BaseSystem> type)
WorldConfigurationBuilder	register(FieldResolver... fieldResolvers) Add field resolver.
WorldConfigurationBuilder	register(SystemInvocationStrategy strategy) Add system invocation strategy.
protected void	registerFieldResolvers(WorldConfiguration config) add custom field handler with resolvers.
WorldConfigurationBuilder	with(ArtemisPlugin... plugins) Add plugins to world.
WorldConfigurationBuilder	with(BaseSystem... systems) Register active system(s).
WorldConfigurationBuilder	with(int priority, BaseSystem... systems) Register active system(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

WorldConfigurationBuilder

public WorldConfigurationBuilder()

Method Detail

build

public WorldConfiguration build()

Assemble world with systems.

Deprecated: World Configuration

registerFieldResolvers

protected void registerFieldResolvers(WorldConfiguration config)

add custom field handler with resolvers.

alwaysDelayComponentRemoval

public WorldConfigurationBuilder alwaysDelayComponentRemoval(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 until all subscriptions have been notified. When false, only components with @DelayedComponentRemoval will be delayed. Components without the annotation will not be retrievable in listeners.

register

public WorldConfigurationBuilder register(FieldResolver... fieldResolvers)

Add field resolver.

Parameters:

fieldResolvers -

Returns:

this

register

public WorldConfigurationBuilder register(SystemInvocationStrategy strategy)

Add system invocation strategy.

Parameters:

strategy - strategy to invoke.

Returns:

this

dependsOn

public final WorldConfigurationBuilder dependsOn(Class... types)

Specify dependency on systems/plugins.

Managers track priority separate from system priority, and are always added before systems.

Artemis will consider abstract plugin dependencies fulfilled when a concrete subclass has been registered beforehand.

Parameters:

types - required systems.

Returns:

this

dependsOn

public final WorldConfigurationBuilder dependsOn(int priority,
                                                 Class... types)

Specify dependency on systems/plugins.

Parameters:

types - required systems.

priority - Higher priority are registered first. Not supported for plugins.

Returns:

this

Throws:

WorldConfigurationException - if unsupported classes are passed or plugins are given a priority.

dependsOnSystem

protected void dependsOnSystem(int priority,
                               Class<? extends BaseSystem> type)
                        throws ReflectionException

Throws:

ReflectionException

with

public WorldConfigurationBuilder with(int priority,
                                      BaseSystem... systems)

Register active system(s). Only one instance of each class is allowed. Use dependsOn(java.lang.Class...) from within plugins whenever possible.

Parameters:

systems - systems to add, order is preserved.

priority - priority of added systems, higher priority are added before lower priority.

Returns:

this

Throws:

WorldConfigurationException - if registering the same class twice.

with

public WorldConfigurationBuilder with(BaseSystem... systems)

Register active system(s). Only one instance of each class is allowed. Use dependsOn(java.lang.Class...) from within plugins whenever possible.

Parameters:

systems - systems to add, order is preserved.

Returns:

this

Throws:

WorldConfigurationException - if registering the same class twice.

with

public WorldConfigurationBuilder with(ArtemisPlugin... plugins)

Add plugins to world.

Upon build plugins will be called to register dependencies.

Only one instance of each class is allowed. Use dependsOn(java.lang.Class...) from within plugins whenever possible.

Parameters:

plugins - Plugins to add.

Returns:

this

Throws:

WorldConfigurationException - if type is added more than once.