org.mini2Dx.ecs.entity

Interface Entity

All Known Implementing Classes:

GameScreenEntity, UUIDEntity

public interface Entity

A common interface for Entity implementations within the Entity-Component-System pattern

Author:

Thomas Cashman

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(Component component) Adds a Component to this Entity and notifies any attached EntityListeners of this addition
void	addEntityListener(EntityListener listener) Adds an EntityListener to this Entity
<T> List<T>	getComponents(Class<T> clazz) Returns all Components that implement the specified the class or interface
<T extends Component> List<T>	removeAllComponentsOfType(Class<T> clazz) Removes all Components that implement a specific type
void	removeComponent(Component component) Removes the specified Component from this Entity
void	removeEntityListener(EntityListener listener) Removes an EntityListener from this Entity

Method Detail

addComponent

void addComponent(Component component)

Adds a Component to this Entity and notifies any attached EntityListeners of this addition

Parameters:

component - An instance of Component

getComponents

<T> List<T> getComponents(Class<T> clazz)

Returns all Components that implement the specified the class or interface

Parameters:

clazz - The Class to search for

Returns:

An empty List if no such Components are attached to this Entity

removeComponent

void removeComponent(Component component)

Removes the specified Component from this Entity

Parameters:

component - The Component to remove

removeAllComponentsOfType

<T extends Component> List<T> removeAllComponentsOfType(Class<T> clazz)

Removes all Components that implement a specific type

Parameters:

clazz - The Class to search for

addEntityListener

void addEntityListener(EntityListener listener)

Adds an EntityListener to this Entity

Parameters:

listener - The EntityListener to add

removeEntityListener

void removeEntityListener(EntityListener listener)

Removes an EntityListener from this Entity

Parameters:

listener - The EntityListener to be removed