com.artemis

Class Aspect.Builder

java.lang.Object

com.artemis.Aspect.Builder

Enclosing class:

Aspect

public static class Aspect.Builder
extends Object

Constructs instances of Aspect.

Method Summary

Modifier and Type	Method and Description
Aspect.Builder	all(Class<? extends Component>... types) Returns an aspect where an entity must possess all of the specified component types.
Aspect.Builder	all(Collection<Class<? extends Component>> types) Returns an aspect where an entity must possess all of the specified component types.
Aspect	build(World world) Bake an aspect.
Aspect.Builder	copy()
boolean	equals(Object o)
Aspect.Builder	exclude(Class<? extends Component>... types) Excludes all of the specified component types from the aspect.
Aspect.Builder	exclude(Collection<Class<? extends Component>> types) Excludes all of the specified component types from the aspect.
int	hashCode()
Aspect.Builder	one(Class<? extends Component>... types) Returns an aspect where an entity must possess one of the specified component types.
Aspect.Builder	one(Collection<Class<? extends Component>> types) Returns an aspect where an entity must possess one of the specified component types.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

all

@SafeVarargs
public final Aspect.Builder all(Class<? extends Component>... types)

Returns an aspect where an entity must possess all of the specified component types.

Parameters:

types - a required component type

Returns:

an aspect that can be matched against entities

copy

public Aspect.Builder copy()

Returns:

new instance of this builder.

all

public Aspect.Builder all(Collection<Class<? extends Component>> types)

Returns an aspect where an entity must possess all of the specified component types.

Parameters:

types - a required component type

Returns:

an aspect that can be matched against entities

one

@SafeVarargs
public final Aspect.Builder one(Class<? extends Component>... types)

Returns an aspect where an entity must possess one of the specified component types.

Parameters:

types - one of the types the entity must possess

Returns:

an aspect that can be matched against entities

one

public Aspect.Builder one(Collection<Class<? extends Component>> types)

Returns an aspect where an entity must possess one of the specified component types.

Parameters:

types - one of the types the entity must possess

Returns:

an aspect that can be matched against entities

exclude

@SafeVarargs
public final Aspect.Builder exclude(Class<? extends Component>... types)

Excludes all of the specified component types from the aspect.

A system will not be interested in an entity that possesses one of the specified exclusion component types.

Parameters:

types - component type to exclude

Returns:

an aspect that can be matched against entities

exclude

public Aspect.Builder exclude(Collection<Class<? extends Component>> types)

Excludes all of the specified component types from the aspect.

A system will not be interested in an entity that possesses one of the specified exclusion component types.

Parameters:

types - component type to exclude

Returns:

an aspect that can be matched against entities

build

public Aspect build(World world)

Bake an aspect.

Parameters:

world -

Returns:

Instance of Aspect.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object