Package ecs

Class Component

java.lang.Object

ecs.Component

All Implemented Interfaces:

Comparable<Component>

Direct Known Subclasses:

CharacterController, CollisionHandler, Dynamics, PointLight, PolygonCollider, SpriteAnimation, SpriteRenderer

public abstract class Component
extends Object
implements Comparable<Component>

Azurite

Abstract structure for ECS Components. It is highly recommended to use this when implementing any system that can/should be applied to a GameObject.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Component.ComponentOrder

Field Summary

Fields

Modifier and Type	Field	Description
GameObject	gameObject	Parent GameObject

Constructor Summary

Constructors

Constructor	Description
Component()
Component(Component.ComponentOrder order)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Component o)
DebugPrimitive[]	debug()	Get an array of debug lines to be rendered in debug mode
protected org.joml.Vector2f	position()	Shortcut to get the current position of the parent gameobject.
void	remove()	Called when component is removed from GameObject.
protected void	setPosition(org.joml.Vector2f position)	Shortcut to overwrite the current position of the parent gameobject.
void	start()	Called once on Component initialization.
void	update(float dt)	Called once per frame for each Component

Methods inherited from class java.lang.Object

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

Field Details

gameObject

public GameObject gameObject

Parent GameObject

Constructor Details

Component

public Component(Component.ComponentOrder order)

Component

public Component()

Method Details

start

public void start()

Called once on Component initialization.

update

public void update(float dt)

Called once per frame for each Component

Parameters:

dt - Engine.deltaTime

debug

public DebugPrimitive[] debug()

Get an array of debug lines to be rendered in debug mode

Returns:

an array of lines to be rendered in debug mode

position

protected org.joml.Vector2f position()

Shortcut to get the current position of the parent gameobject.

Returns:

the current position of the parent gameobject

setPosition

protected void setPosition(org.joml.Vector2f position)

Shortcut to overwrite the current position of the parent gameobject.

compareTo

public int compareTo(Component o)

Specified by:

compareTo in interface Comparable<Component>

remove

public void remove()

Called when component is removed from GameObject.