stream.alwaysbecrafting.flare

Class Entity

java.lang.Object

stream.alwaysbecrafting.flare.Entity

public class Entity
extends java.lang.Object

A group of components that exist and are processed together

Entity should usually not be extended; instead, users of this class should create new Entities, give them components in add(Object), and then add the Entity to the engine with GameEngine.add(Entity).

Constructor Summary

Constructors

Constructor and Description
Entity(java.lang.Object... components)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object component) Add a component to this Entity if a component of the same type does not already exist
<T> T	get(java.lang.Class<T> componentType) Retrieves a component from this Entity
GameEngine	getEngine()
boolean	hasAll(java.util.Collection<java.lang.Class<?>> componentTypes)
boolean	hasAny(java.util.Collection<java.lang.Class<?>> componentTypes)
boolean	hasNone(java.util.Collection<java.lang.Class<?>> componentTypes)
boolean	remove(java.lang.Class<?> componentType) Removes a component from this Entity
void	setEngine(GameEngine engine)

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity(java.lang.Object... components)

Method Detail

setEngine

public void setEngine(GameEngine engine)

getEngine

public GameEngine getEngine()

add

public boolean add(java.lang.Object component)

Add a component to this Entity if a component of the same type does not already exist

Parameters:

component - The component to add

Returns:

true if the component was added, else false

get

public <T> T get(java.lang.Class<T> componentType)

Retrieves a component from this Entity

Parameters:

componentType - The class of the component to retrieve

Returns:

If it exists, the component of the given class, else null

remove

public boolean remove(java.lang.Class<?> componentType)

Removes a component from this Entity

Parameters:

componentType - The class of the component to retrieve

Returns:

true if a component was removed, else false

hasAll

public boolean hasAll(java.util.Collection<java.lang.Class<?>> componentTypes)

Parameters:

componentTypes - Classes to match against this entity's components

Returns:

true if there is a component of every listed type, else false

hasAny

public boolean hasAny(java.util.Collection<java.lang.Class<?>> componentTypes)

Parameters:

componentTypes - Classes to match against this entity's components

Returns:

true if there is a component of at least one listed type, else false

hasNone

public boolean hasNone(java.util.Collection<java.lang.Class<?>> componentTypes)

Parameters:

componentTypes - Classes to match against this entity's components

Returns:

true if there are no components of the listed types, else false