com.artemis.utils

Class EntityBuilder

java.lang.Object

com.artemis.utils.EntityBuilder

public class EntityBuilder
extends Object

Non-reusable entity creation helper for rapid prototyping. Discouraged for use other than rapid prototyping and simple games. Use ComponentMapper instead, or check out the Fluid Entity interface. Example: new Builder(world) .with(Pos.class, Anim.class) .tag("boss") .player("player1") .group("enemies") .build();

Author:

Daan van Yperen, Junkdog

See Also:

for a list of alternate ways to alter composition and access components.

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityEdit	edit
protected World	world

Constructor Summary

Constructors

Constructor and Description
EntityBuilder(World world) Begin building new entity.
EntityBuilder(World world, Archetype archetype) Begin building new entity based on archetype.

Method Summary

Modifier and Type	Method and Description
Entity	build() Assemble, add to world
EntityBuilder	group(String group) Register entity with group.
EntityBuilder	groups(String... groups) Register entity with multiple groups.
EntityBuilder	player(String player) Register entity with owning player.
protected <T extends BaseSystem> T	resolveManager(Class<T> type) Fetch manager or throw RuntimeException if not registered.
EntityBuilder	tag(String tag) Register entity with tag.
EntityBuilder	UUID(UUID uuid) Set UUID of entity
EntityBuilder	with(Class<? extends Component>... components) Add artemis managed components to entity.
EntityBuilder	with(Class<? extends Component> component) Add artemis managed components to entity.
EntityBuilder	with(Class<? extends Component> component1, Class<? extends Component> component2) Add artemis managed components to entity.
EntityBuilder	with(Class<? extends Component> component1, Class<? extends Component> component2, Class<? extends Component> component3) Add artemis managed components to entity.
EntityBuilder	with(Class<? extends Component> component1, Class<? extends Component> component2, Class<? extends Component> component3, Class<? extends Component> component4) Add artemis managed components to entity.
EntityBuilder	with(Class<? extends Component> component1, Class<? extends Component> component2, Class<? extends Component> component3, Class<? extends Component> component4, Class<? extends Component> component5) Add artemis managed components to entity.
EntityBuilder	with(Component... components) Add components to entity.
EntityBuilder	with(Component component) Add component to entity.
EntityBuilder	with(Component component1, Component component2) Add components to entity.
EntityBuilder	with(Component component1, Component component2, Component component3) Add components to entity.
EntityBuilder	with(Component component1, Component component2, Component component3, Component component4) Add components to entity.
EntityBuilder	with(Component component1, Component component2, Component component3, Component component4, Component component5) Add components to entity.

Methods inherited from class java.lang.Object

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

Field Detail

world

protected final World world

edit

protected final EntityEdit edit

Constructor Detail

EntityBuilder

public EntityBuilder(World world)

Begin building new entity.

EntityBuilder

public EntityBuilder(World world,
                     Archetype archetype)

Begin building new entity based on archetype.

Method Detail

with

public EntityBuilder with(Component component)

Add component to entity.

with

public EntityBuilder with(Component component1,
                          Component component2)

Add components to entity.

with

public EntityBuilder with(Component component1,
                          Component component2,
                          Component component3)

Add components to entity.

with

public EntityBuilder with(Component component1,
                          Component component2,
                          Component component3,
                          Component component4)

Add components to entity.

with

public EntityBuilder with(Component component1,
                          Component component2,
                          Component component3,
                          Component component4,
                          Component component5)

Add components to entity.

with

public EntityBuilder with(Component... components)

Add components to entity.

with

public EntityBuilder with(Class<? extends Component> component)

Add artemis managed components to entity.

with

public EntityBuilder with(Class<? extends Component> component1,
                          Class<? extends Component> component2)

Add artemis managed components to entity.

with

public EntityBuilder with(Class<? extends Component> component1,
                          Class<? extends Component> component2,
                          Class<? extends Component> component3)

Add artemis managed components to entity.

with

public EntityBuilder with(Class<? extends Component> component1,
                          Class<? extends Component> component2,
                          Class<? extends Component> component3,
                          Class<? extends Component> component4)

Add artemis managed components to entity.

with

public EntityBuilder with(Class<? extends Component> component1,
                          Class<? extends Component> component2,
                          Class<? extends Component> component3,
                          Class<? extends Component> component4,
                          Class<? extends Component> component5)

Add artemis managed components to entity.

with

public EntityBuilder with(Class<? extends Component>... components)

Add artemis managed components to entity.

UUID

public EntityBuilder UUID(UUID uuid)

Set UUID of entity

player

public EntityBuilder player(String player)

Register entity with owning player. An entity can only belong to a single player at a time. Requires registered PlayerManager.

tag

public EntityBuilder tag(String tag)

Register entity with tag. Requires registered TagManager

group

public EntityBuilder group(String group)

Register entity with group. Requires registered TagManager

groups

public EntityBuilder groups(String... groups)

Register entity with multiple groups. Requires registered TagManager

build

public Entity build()

Assemble, add to world

resolveManager

protected <T extends BaseSystem> T resolveManager(Class<T> type)

Fetch manager or throw RuntimeException if not registered.