org.mini2Dx.ecs.component

Class Component

java.lang.Object

org.mini2Dx.ecs.component.Component

All Implemented Interfaces:

java.lang.Comparable<Component>

Direct Known Subclasses:

PositionTracker, PriorityComponent, UpdatableComponent

public class Component
extends java.lang.Object
implements java.lang.Comparable<Component>

A common interface for implementing Components as part of the Entity-Component-System pattern

Constructor Summary

Constructors

Constructor and Description
Component(java.lang.String name) Default constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(Component o)
void	destroy()
<T extends Component> T	getComponent(java.lang.Class<T> clazz)
<T extends Component> 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 extends Component> T	getComponentInDescendants(java.lang.Class<T> clazz)
<T extends Component> T	getComponentInDescendants(int componentTypeId)
<T extends Component> T	getComponentInDescendants(java.lang.String name, java.lang.Class<T> clazz)
<T extends Component> T	getComponentInDescendants(java.lang.String name, int componentTypeId)
<T extends Component> java.util.SortedSet<T>	getComponents(java.lang.Class<T> clazz)
<T extends Component> java.util.SortedSet<T>	getComponents(int componentTypeId)
<T extends Component> java.util.SortedSet<T>	getComponentsInDescendants(java.lang.Class<T> clazz)
<T extends Component> java.util.SortedSet<T>	getComponentsInDescendants(int componentTypeId)
int	getComponentTypeId()
Entity	getEntity()
java.lang.String	getName()
void	onAddToEntity() Called when this Component is added to an Entity By default this does nothing, can be overridden by developer
void	setEntity(Entity entity)

Methods inherited from class java.lang.Object

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

Constructor Detail

Component

public Component(java.lang.String name)

Default constructor

Parameters:

name - The name of this component

Method Detail

onAddToEntity

public void onAddToEntity()

Called when this Component is added to an Entity By default this does nothing, can be overridden by developer

getComponent

public <T extends Component> T getComponent(java.lang.Class<T> clazz)

getComponent

public <T extends Component> T getComponent(int componentTypeId)

getComponent

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

getComponent

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

getComponents

public <T extends Component> java.util.SortedSet<T> getComponents(java.lang.Class<T> clazz)

getComponents

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

getComponentInDescendants

public <T extends Component> T getComponentInDescendants(java.lang.Class<T> clazz)

getComponentInDescendants

public <T extends Component> T getComponentInDescendants(int componentTypeId)

getComponentInDescendants

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

getComponentInDescendants

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

getComponentsInDescendants

public <T extends Component> java.util.SortedSet<T> getComponentsInDescendants(java.lang.Class<T> clazz)

getComponentsInDescendants

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

destroy

public void destroy()

getName

public java.lang.String getName()

getEntity

public Entity getEntity()

setEntity

public void setEntity(Entity entity)

compareTo

public int compareTo(Component o)

Specified by:

compareTo in interface java.lang.Comparable<Component>

getComponentTypeId

public int getComponentTypeId()