Skip navigation links
A B C D E F G H I L M O P R S T U 

A

add(Component) - Method in class com.badlogic.ashley.core.Entity
Adds a Component to this Entity.
add(Listener<T>) - Method in class com.badlogic.ashley.signals.Signal
Add a Listener to this Signal
add(E) - Method in class com.badlogic.ashley.utils.Bag
Adds the specified element to the end of this bag.
addAndReturn(T) - Method in class com.badlogic.ashley.core.Entity
Adds a Component to this Entity.
addedToEngine(Engine) - Method in class com.badlogic.ashley.core.EntitySystem
Called when this EntitySystem is added to an Engine.
addedToEngine(Engine) - Method in class com.badlogic.ashley.systems.IntervalIteratingSystem
 
addedToEngine(Engine) - Method in class com.badlogic.ashley.systems.IteratingSystem
 
addedToEngine(Engine) - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
addEntity(Entity) - Method in class com.badlogic.ashley.core.Engine
Adds an entity to this Engine.
addEntityInternal(Entity) - Method in class com.badlogic.ashley.core.Engine
 
addEntityListener(EntityListener) - Method in class com.badlogic.ashley.core.Engine
addEntityListener(int, EntityListener) - Method in class com.badlogic.ashley.core.Engine
addEntityListener(Family, EntityListener) - Method in class com.badlogic.ashley.core.Engine
Adds an EntityListener for a specific Family.
addEntityListener(Family, int, EntityListener) - Method in class com.badlogic.ashley.core.Engine
Adds an EntityListener for a specific Family.
addSystem(EntitySystem) - Method in class com.badlogic.ashley.core.Engine
Adds the EntitySystem to this Engine.
all(Class<? extends Component>...) - Static method in class com.badlogic.ashley.core.Family
 
all(Class<? extends Component>...) - Method in class com.badlogic.ashley.core.Family.Builder
 

B

Bag<E> - Class in com.badlogic.ashley.utils
Fast collection similar to Array that grows on demand as elements are accessed.
Bag() - Constructor for class com.badlogic.ashley.utils.Bag
Empty Bag with an initial capacity of 64.
Bag(int) - Constructor for class com.badlogic.ashley.utils.Bag
Empty Bag with the specified initial capacity.

C

checkProcessing() - Method in class com.badlogic.ashley.core.EntitySystem
 
clear() - Method in class com.badlogic.ashley.utils.Bag
Removes all of the elements from this bag.
clearPools() - Method in class com.badlogic.ashley.core.PooledEngine
Removes all free entities and components from their pools.
com.badlogic.ashley.core - package com.badlogic.ashley.core
 
com.badlogic.ashley.signals - package com.badlogic.ashley.signals
 
com.badlogic.ashley.systems - package com.badlogic.ashley.systems
 
com.badlogic.ashley.utils - package com.badlogic.ashley.utils
 
Component - Interface in com.badlogic.ashley.core
Interface for all Components.
componentAdded - Variable in class com.badlogic.ashley.core.Entity
Will dispatch an event when a component is added.
ComponentMapper<T extends Component> - Class in com.badlogic.ashley.core
Provides super fast Component retrieval from objects.
componentRemoved - Variable in class com.badlogic.ashley.core.Entity
Will dispatch an event when a component is removed.
ComponentType - Class in com.badlogic.ashley.core
Uniquely identifies a Component sub-class.
contains(E) - Method in class com.badlogic.ashley.utils.Bag
Check if bag contains this element.
contains(T, boolean) - Method in class com.badlogic.ashley.utils.ImmutableArray
 
createComponent(Class<T>) - Method in class com.badlogic.ashley.core.Engine
Creates a new Component.
createComponent(Class<T>) - Method in class com.badlogic.ashley.core.PooledEngine
Retrieves a new Component from the Engine pool.
createEntity() - Method in class com.badlogic.ashley.core.Engine
Creates a new Entity object.
createEntity() - Method in class com.badlogic.ashley.core.PooledEngine
 

D

dispatch(T) - Method in class com.badlogic.ashley.signals.Signal
Dispatches an event to all Listeners registered to this Signal

E

Engine - Class in com.badlogic.ashley.core
The heart of the Entity framework.
Engine() - Constructor for class com.badlogic.ashley.core.Engine
 
Entity - Class in com.badlogic.ashley.core
Simple containers of Components that give them "data".
Entity() - Constructor for class com.badlogic.ashley.core.Entity
Creates an empty Entity.
entityAdded(Entity) - Method in interface com.badlogic.ashley.core.EntityListener
entityAdded(Entity) - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
EntityListener - Interface in com.badlogic.ashley.core
Gets notified of Entity related events.
entityRemoved(Entity) - Method in interface com.badlogic.ashley.core.EntityListener
entityRemoved(Entity) - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
EntitySystem - Class in com.badlogic.ashley.core
Abstract class for processing sets of Entity objects.
EntitySystem() - Constructor for class com.badlogic.ashley.core.EntitySystem
Default constructor that will initialise an EntitySystem with priority 0.
EntitySystem(int) - Constructor for class com.badlogic.ashley.core.EntitySystem
Initialises the EntitySystem with the priority specified.
equals(Object) - Method in class com.badlogic.ashley.core.ComponentType
 
equals(Object) - Method in class com.badlogic.ashley.core.Family
 
equals(Object) - Method in class com.badlogic.ashley.utils.ImmutableArray
 
exclude(Class<? extends Component>...) - Method in class com.badlogic.ashley.core.Family.Builder
 
exclude(Class<? extends Component>...) - Static method in class com.badlogic.ashley.core.Family
 

F

Family - Class in com.badlogic.ashley.core
Represents a group of Components.
Family.Builder - Class in com.badlogic.ashley.core
 
first() - Method in class com.badlogic.ashley.utils.ImmutableArray
 
flags - Variable in class com.badlogic.ashley.core.Entity
A flag that can be used to bit mask this entity.
forceSort() - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
Call this if the sorting criteria have changed.

G

get(Entity) - Method in class com.badlogic.ashley.core.ComponentMapper
 
get() - Method in class com.badlogic.ashley.core.Family.Builder
 
get(int) - Method in class com.badlogic.ashley.utils.Bag
 
get(int) - Method in class com.badlogic.ashley.utils.ImmutableArray
 
getBitsFor(Class<? extends Component>...) - Static method in class com.badlogic.ashley.core.ComponentType
 
getCapacity() - Method in class com.badlogic.ashley.utils.Bag
 
getComponent(Class<T>) - Method in class com.badlogic.ashley.core.Entity
Retrieve a component from this Entity by class.
getComponents() - Method in class com.badlogic.ashley.core.Entity
 
getEngine() - Method in class com.badlogic.ashley.core.EntitySystem
 
getEntities() - Method in class com.badlogic.ashley.core.Engine
Returns an ImmutableArray of Entity that is managed by the the Engine but cannot be used to modify the state of the Engine.
getEntities() - Method in class com.badlogic.ashley.systems.IntervalIteratingSystem
 
getEntities() - Method in class com.badlogic.ashley.systems.IteratingSystem
 
getEntities() - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
getEntitiesFor(Family) - Method in class com.badlogic.ashley.core.Engine
Returns immutable collection of entities for the specified Family.
getFamily() - Method in class com.badlogic.ashley.systems.IntervalIteratingSystem
 
getFamily() - Method in class com.badlogic.ashley.systems.IteratingSystem
 
getFamily() - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
getFor(Class<T>) - Static method in class com.badlogic.ashley.core.ComponentMapper
 
getFor(Class<? extends Component>) - Static method in class com.badlogic.ashley.core.ComponentType
 
getIndex() - Method in class com.badlogic.ashley.core.ComponentType
 
getIndex() - Method in class com.badlogic.ashley.core.Family
 
getIndexFor(Class<? extends Component>) - Static method in class com.badlogic.ashley.core.ComponentType
Quick helper method.
getInterval() - Method in class com.badlogic.ashley.systems.IntervalSystem
 
getSystem(Class<T>) - Method in class com.badlogic.ashley.core.Engine
Quick EntitySystem retrieval.
getSystems() - Method in class com.badlogic.ashley.core.Engine
 

H

has(Entity) - Method in class com.badlogic.ashley.core.ComponentMapper
 
hashCode() - Method in class com.badlogic.ashley.core.ComponentType
 
hashCode() - Method in class com.badlogic.ashley.core.Family
 
hashCode() - Method in class com.badlogic.ashley.utils.ImmutableArray
 

I

ImmutableArray<T> - Class in com.badlogic.ashley.utils
Wrapper class to treat Array objects as if they were immutable.
ImmutableArray(Array<T>) - Constructor for class com.badlogic.ashley.utils.ImmutableArray
 
indexOf(T, boolean) - Method in class com.badlogic.ashley.utils.ImmutableArray
 
IntervalIteratingSystem - Class in com.badlogic.ashley.systems
A simple EntitySystem that processes a Family of entities not once per frame, but after a given interval.
IntervalIteratingSystem(Family, float) - Constructor for class com.badlogic.ashley.systems.IntervalIteratingSystem
 
IntervalIteratingSystem(Family, float, int) - Constructor for class com.badlogic.ashley.systems.IntervalIteratingSystem
 
IntervalSystem - Class in com.badlogic.ashley.systems
A simple EntitySystem that does not run its update logic every call to EntitySystem.update(float), but after a given interval.
IntervalSystem(float) - Constructor for class com.badlogic.ashley.systems.IntervalSystem
 
IntervalSystem(float, int) - Constructor for class com.badlogic.ashley.systems.IntervalSystem
 
isEmpty() - Method in class com.badlogic.ashley.utils.Bag
 
isIndexWithinBounds(int) - Method in class com.badlogic.ashley.utils.Bag
 
isRemoving() - Method in class com.badlogic.ashley.core.Entity
 
isScheduledForRemoval() - Method in class com.badlogic.ashley.core.Entity
 
IteratingSystem - Class in com.badlogic.ashley.systems
A simple EntitySystem that iterates over each entity and calls processEntity() for each entity every time the EntitySystem is updated.
IteratingSystem(Family) - Constructor for class com.badlogic.ashley.systems.IteratingSystem
Instantiates a system that will iterate over the entities described by the Family.
IteratingSystem(Family, int) - Constructor for class com.badlogic.ashley.systems.IteratingSystem
Instantiates a system that will iterate over the entities described by the Family, with a specific priority.
iterator() - Method in class com.badlogic.ashley.utils.ImmutableArray
 

L

lastIndexOf(T, boolean) - Method in class com.badlogic.ashley.utils.ImmutableArray
 
Listener<T> - Interface in com.badlogic.ashley.signals
A simple Listener interface used to listen to a Signal.

M

matches(Entity) - Method in class com.badlogic.ashley.core.Family
 

O

one(Class<? extends Component>...) - Method in class com.badlogic.ashley.core.Family.Builder
 
one(Class<? extends Component>...) - Static method in class com.badlogic.ashley.core.Family
 

P

peek() - Method in class com.badlogic.ashley.utils.ImmutableArray
 
PooledEngine - Class in com.badlogic.ashley.core
Supports Entity and Component pooling.
PooledEngine() - Constructor for class com.badlogic.ashley.core.PooledEngine
Creates a new PooledEngine with a maximum of 100 entities and 100 components of each type.
PooledEngine(int, int, int, int) - Constructor for class com.badlogic.ashley.core.PooledEngine
Creates new PooledEngine with the specified pools size configurations.
priority - Variable in class com.badlogic.ashley.core.EntitySystem
Use this to set the priority of the system.
processEntity(Entity) - Method in class com.badlogic.ashley.systems.IntervalIteratingSystem
The user should place the entity processing logic here.
processEntity(Entity, float) - Method in class com.badlogic.ashley.systems.IteratingSystem
This method is called on every entity on every update call of the EntitySystem.
processEntity(Entity, float) - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
This method is called on every entity on every update call of the EntitySystem.

R

random() - Method in class com.badlogic.ashley.utils.ImmutableArray
 
receive(Signal<T>, T) - Method in interface com.badlogic.ashley.signals.Listener
 
remove(Class<T>) - Method in class com.badlogic.ashley.core.Entity
Removes the Component of the specified type.
remove(Listener<T>) - Method in class com.badlogic.ashley.signals.Signal
Remove a listener from this Signal
remove(int) - Method in class com.badlogic.ashley.utils.Bag
Removes the element at the specified position in this Bag.
remove(E) - Method in class com.badlogic.ashley.utils.Bag
Removes the first occurrence of the specified element from this Bag, if it is present.
removeAll() - Method in class com.badlogic.ashley.core.Entity
Removes all the Component's from the Entity.
removeAllEntities(Family) - Method in class com.badlogic.ashley.core.Engine
Removes all entities of the given Family.
removeAllEntities() - Method in class com.badlogic.ashley.core.Engine
Removes all entities registered with this Engine.
removeAllListeners() - Method in class com.badlogic.ashley.signals.Signal
Removes all listeners attached to this Signal.
removeAllSystems() - Method in class com.badlogic.ashley.core.Engine
Removes all systems from this Engine.
removedFromEngine(Engine) - Method in class com.badlogic.ashley.core.EntitySystem
Called when this EntitySystem is removed from an Engine.
removedFromEngine(Engine) - Method in class com.badlogic.ashley.systems.IteratingSystem
 
removedFromEngine(Engine) - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
removeEntity(Entity) - Method in class com.badlogic.ashley.core.Engine
Removes an entity from this Engine.
removeEntityInternal(Entity) - Method in class com.badlogic.ashley.core.Engine
 
removeEntityInternal(Entity) - Method in class com.badlogic.ashley.core.PooledEngine
 
removeEntityListener(EntityListener) - Method in class com.badlogic.ashley.core.Engine
Removes an EntityListener
removeLast() - Method in class com.badlogic.ashley.utils.Bag
Removes and return the last object in the bag.
removeSystem(EntitySystem) - Method in class com.badlogic.ashley.core.Engine
Removes the EntitySystem from this Engine.
reset() - Method in class com.badlogic.ashley.core.Family.Builder
Resets the builder instance

S

set(int, E) - Method in class com.badlogic.ashley.utils.Bag
Set element at specified index in the bag.
setProcessing(boolean) - Method in class com.badlogic.ashley.core.EntitySystem
Sets whether or not the system should be processed by the Engine.
Signal<T> - Class in com.badlogic.ashley.signals
A Signal is a basic event class that can dispatch an event to multiple listeners.
Signal() - Constructor for class com.badlogic.ashley.signals.Signal
 
size() - Method in class com.badlogic.ashley.utils.Bag
 
size() - Method in class com.badlogic.ashley.utils.ImmutableArray
 
SortedIteratingSystem - Class in com.badlogic.ashley.systems
A simple EntitySystem that processes each entity of a given family in the order specified by a comparator and calls processEntity() for each entity every time the EntitySystem is updated.
SortedIteratingSystem(Family, Comparator<Entity>) - Constructor for class com.badlogic.ashley.systems.SortedIteratingSystem
Instantiates a system that will iterate over the entities described by the Family.
SortedIteratingSystem(Family, Comparator<Entity>, int) - Constructor for class com.badlogic.ashley.systems.SortedIteratingSystem
Instantiates a system that will iterate over the entities described by the Family, with a specific priority.

T

toArray() - Method in class com.badlogic.ashley.utils.ImmutableArray
 
toArray(Class<V>) - Method in class com.badlogic.ashley.utils.ImmutableArray
 
toString() - Method in class com.badlogic.ashley.utils.ImmutableArray
 
toString(String) - Method in class com.badlogic.ashley.utils.ImmutableArray
 

U

update(float) - Method in class com.badlogic.ashley.core.Engine
Updates all the systems in this Engine.
update(float) - Method in class com.badlogic.ashley.core.EntitySystem
The update method called every tick.
update(float) - Method in class com.badlogic.ashley.systems.IntervalSystem
 
update(float) - Method in class com.badlogic.ashley.systems.IteratingSystem
 
update(float) - Method in class com.badlogic.ashley.systems.SortedIteratingSystem
 
updateInterval() - Method in class com.badlogic.ashley.systems.IntervalIteratingSystem
 
updateInterval() - Method in class com.badlogic.ashley.systems.IntervalSystem
The processing logic of the system should be placed here.
A B C D E F G H I L M O P R S T U 
Skip navigation links