Package-level declarations
Types
Marks KTX Ashley type-safe builders.
Property delegate for an Entity wrapping around a ComponentMapper. Allows accessing components assigned to entities with the property syntax. Designed for non-nullable components that are available for all entities without the risk of a NullPointerException.
Thrown when unable to create a component of given type.
An Entity created by the provided Engine.
An EntityListener only requiring an implementation of the entityAdded method.
An EntityListener only requiring an implementation of the entityRemoved method.
Thrown when accessing an EntitySystem via getSystem that does not exist in the Engine.
Property delegate for an Entity wrapping around a ComponentMapper. Designed for components that might not be defined for each entity and can be null. Attempting to assign a null value to the property will remove the component from the entity.
Property delegate for an Entity wrapping around a ComponentMapper. Allows checking the presence of a Component of an Entity. Automatically creates instances of the T if its value is set to true
.
Property delegate for an Entity wrapping around a ComponentMapper. Allows checking the presence of a Component of an Entity. Automatically assigns a singleton instance of the T if its value is set to true
. This property delegate should be used only for stateless components without any mutable properties.
Common interface for property delegates wrapping around flag components. These properties should generally wrap Components that do not have any fields, and instead their presence alone is used for filtering or associated logic. An example of such component could be a Visible
class that marks entities that should be rendered.
Functions
Adds a Component to this Entity. If a Component of the same type already exists, it will be replaced.
Allows to configure an existing Entity with this Engine.
Create and add an Entity to the Engine.
A wrapper for Engine.onEntityAdded that uses this IntervalIteratingSystem's Family as a filter for the EntityAdditionListener.
A wrapper for Engine.onEntityAdded that uses this IteratingSystem's Family as a filter for the EntityAdditionListener.
A wrapper for Engine.onEntityAdded that uses this SortedIteratingSystem's Family as a filter for the EntityAdditionListener.
Adds an EntityAdditionListener to this Engine and returns a reference to the new listener instance. The listener calls onAdded lambda every time an entity addition event is triggered.
A wrapper for Engine.onEntityRemoved that uses this IntervalIteratingSystem's Family as a filter for the EntityRemovalListener.
A wrapper for Engine.onEntityRemoved that uses this IteratingSystem's Family as a filter for the EntityRemovalListener.
A wrapper for Engine.onEntityRemoved that uses this SortedIteratingSystem's Family as a filter for the EntityRemovalListener.
Adds an EntityRemovalListener to this Engine and returns a reference to the new listener instance. The listener calls onRemoved lambda every time an entity addition event is triggered.
Returns a delegated property for the Entity class to access the given Component. Allows accessing and setting optional components assigned to entities with the property syntax. Attempting to assign a null value to the property will remove the component it from the entity.
Adds a constructed Component to this Entity. If a Component of the same type exists, it will be replaced.
Returns a delegated property for the Entity class to access the given Component. Allows accessing and setting mandatory components assigned to entities with the property syntax.
Returns a delegated property for the Entity class that check if the given Component is present within the entity. Changing the boolean value of the property will either add or remove the component from the entity, depending on whether the value is true
or false
respectively.