org.mini2Dx.ecs.component

Interface ComponentStore

All Known Implementing Classes:

DefaultComponentStore, Entity, GameScreenEntity

public interface ComponentStore

A common interface for a datastore of Components

Method Summary

Modifier and Type	Method and Description
void	addComponent(Component component) Adds a Component to this Entity and notifies any attached EntityListeners of this addition
<T> T	getComponent(java.lang.Class<T> clazz)
<T> T	getComponent(int componentTypeId)
<T extends Component> T	getComponent(java.lang.String name, java.lang.Class<T> clazz)
<T extends Component> T	getComponent(java.lang.String name, int componentTypeId)
<T> java.util.SortedSet<T>	getComponents(java.lang.Class<T> clazz) Returns all Components that implement the specified the class or interface
<T> java.util.SortedSet<T>	getComponents(int componentTypeId) Returns all Components that implement the specified the class or interface
<T extends Component> java.util.SortedSet<T>	removeAllComponentsOfType(java.lang.Class<T> clazz) Removes all Components that implement a specific type
<T extends Component> java.util.SortedSet<T>	removeAllComponentsOfType(int componentTypeId) Removes all Components that implement a specific type
void	removeComponent(Component component) Removes the specified Component from this Entity

Method Detail

getComponent

<T> T getComponent(java.lang.Class<T> clazz)

getComponent

<T> T getComponent(int componentTypeId)

getComponent

<T extends Component> T getComponent(java.lang.String name,
                                     int componentTypeId)

getComponent

<T extends Component> T getComponent(java.lang.String name,
                                     java.lang.Class<T> clazz)

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> java.util.SortedSet<T> getComponents(int componentTypeId)

Returns all Components that implement the specified the class or interface

Parameters:

componentTypeId - The unique identifier of the component type

Returns:

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

getComponents

<T> java.util.SortedSet<T> getComponents(java.lang.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> java.util.SortedSet<T> removeAllComponentsOfType(java.lang.Class<T> clazz)

Removes all Components that implement a specific type

Parameters:

clazz - The Class to search for

removeAllComponentsOfType

<T extends Component> java.util.SortedSet<T> removeAllComponentsOfType(int componentTypeId)

Removes all Components that implement a specific type

Parameters:

componentTypeId - The unique identifier of the component type