Class ActionQueue

Action Queues represent an ordered sequence of actions

Action queues are part of the [[ActionContext|Action API]] and store the list of actions to be executed for an [[Actor]].

Actors implement [[Actor.actions]] which can be manipulated by advanced users to adjust the actions currently being executed in the queue.

Hierarchy

ActionQueue

Index

Constructors

Methods

add clearActions getActions hasNext isComplete remove reset update

Constructors

constructor

new ActionQueue(entity): ActionQueue
Parameters
- entity: Entity
Returns ActionQueue
- Defined in Actions/ActionQueue.ts:19

Methods

add

add(action): void
Add an action to the sequence
Parameters
- action: Action
Returns void
- Defined in Actions/ActionQueue.ts:27

clearActions

clearActions(): void
Removes all actions from this sequence

Returns void
- Defined in Actions/ActionQueue.ts:43

getActions

getActions(): Action[]
Returns Action[]
The total list of actions in this sequence complete or not
- Defined in Actions/ActionQueue.ts:55

hasNext

hasNext(): boolean
Returns boolean
true if there are more actions to process in the sequence
- Defined in Actions/ActionQueue.ts:63

isComplete

isComplete(): boolean
Returns boolean
true if the current sequence of actions is done
- Defined in Actions/ActionQueue.ts:70

remove

remove(action): void
Remove an action by reference from the sequence
Parameters
- action: Action
Returns void
- Defined in Actions/ActionQueue.ts:35

reset

reset(): void
Resets the sequence of actions, this is used to restart a sequence from the beginning

Returns void
- Defined in Actions/ActionQueue.ts:77

update

update(elapsedMs): void
Update the queue which updates actions and handles completing actions
Parameters
- elapsedMs: number
Returns void
- Defined in Actions/ActionQueue.ts:91