com.artemis

Class ArchetypeBuilder

java.lang.Object

com.artemis.ArchetypeBuilder

public class ArchetypeBuilder
extends Object

Builder for basic Archetype instances. To reap the maximum benefit of Archetypes, it's recommended to stash them away inside an EntityFactory or similar. Archetypes main advantage come from the improved insertion into systems and managers performance. Calling edit() on the Entity returned by World#createEntity(Archetype) nullifies this optimization.

Generated archetypes provide a blueprint for quick entity creation. Instance generated entities using World#createEntity(Archetype)

Since:

0.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchetypeBuilder.Archetype Provides a blueprint for new entities, offering greatly improved insertion performance for systems and managers.

Constructor Summary

Constructors

Constructor and Description
ArchetypeBuilder() Constructs an empty archetype builder.
ArchetypeBuilder(ArchetypeBuilder.Archetype parent) Constructs an archetype builder containing the composition of the specified parent.

Method Summary

Methods

Modifier and Type	Method and Description
ArchetypeBuilder	add(Class<? extends Component> type) Ensure this builder includes the specified component type.
ArchetypeBuilder.Archetype	build(World world) Create a new world specific instance of Archetype based on the current state.
ArchetypeBuilder	remove(Class<? extends Component> type) Remove the specified component from this builder, if it is present (optional operation).

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchetypeBuilder

public ArchetypeBuilder(ArchetypeBuilder.Archetype parent)

Constructs an archetype builder containing the composition of the specified parent.

Parameters:

parent - archetype composition to copy.

ArchetypeBuilder

public ArchetypeBuilder()

Constructs an empty archetype builder.

Method Detail

add

public ArchetypeBuilder add(Class<? extends Component> type)

Ensure this builder includes the specified component type.

Parameters:

type -

Returns:

This instance for chaining.

remove

public ArchetypeBuilder remove(Class<? extends Component> type)

Remove the specified component from this builder, if it is present (optional operation).

Parameters:

type -

Returns:

This instance for chaining.

build

public ArchetypeBuilder.Archetype build(World world)

Create a new world specific instance of Archetype based on the current state.

Parameters:

world - applicable domain of the Archetype.

Returns:

new Archetype based on current state