interface Component

Known direct subclasses
BoundsComponent

A component that monitors the bounds of an entity and notifies registered listeners of changes.
InteractableComponent

Provides access to raw InputEvents for given Entity, so a client can implement their own interaction logic.
MovableComponent

This Component can be attached to a single instance of an Entity.
PointerCaptureComponent

Provides pointer capture capabilities for a given Entity.
ResizableComponent

This Component can be attached to a single instance of an Entity.
SpatialPointerComponent

Component that modifies the pointer icon that is rendered on the component's Entity.

A Component adds functionality or behaviors to an Entity.

Summary

Public functions
Boolean
onAttach(entity: Entity)

Called by the framework when this component is being added to an Entity.
Unit
onDetach(entity: Entity)

Called by the framework when this component is being removed from an Entity.

Public functions

onAttach

Added in 1.0.0-alpha14
fun onAttach(entity: Entity): Boolean

Called by the framework when this component is being added to an Entity.

This method is triggered when Entity.addComponent is invoked. It should not be called directly by applications. Implementations should override this method to perform setup logic or to validate if the component is compatible with the provided entity.

Parameters
entity: Entity

The Entity to which this component is being attached.
Returns
Boolean

true if the component was successfully attached; false if the entity does not support this component or if attachment failed.

onDetach

Added in 1.0.0-alpha14
fun onDetach(entity: Entity): Unit

Called by the framework when this component is being removed from an Entity.

This method is triggered when Entity.removeComponent is invoked. It should not be called directly by applications. Implementations should override this method to release resources or undo any changes made during onAttach.

Parameters
entity: Entity

The Entity from which this component is being detached.