Lua API
On this page

ActionQueue

Inherits from

The action queue handles queue and running actions based on priority. Using the queue system allows for multiple scripts to coexist.

Fields:

ImmediateQueue QueueAction[]

read only

The current immediate queue. This includes all QueueAction's that are of type ActionType.

Queue QueueAction[]

read only

The current queue. This includes all QueueAction's that are not of type ActionType.

Methods:

Add(action: QueueAction) : boolean

Add the specified action to the queue. Actions that already exist in the queue will not be added.

Parameters:
NameTypeDefaultSummary
actionQueueAction

The action to add

Returns:boolean

Contains(action: QueueAction) : boolean

Check if the specified action is in the queue. This checks both the normal queue and the immediate queue.

Parameters:
NameTypeDefaultSummary
actionQueueAction

The action to check

Returns:boolean

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

Remove(action: QueueAction) : nil

Remove the specified action from the queue. This will cause it to fail with ActionError.Cancelled

Parameters:
NameTypeDefaultSummary
actionQueueAction

The action to remove

Returns:nil

ToString() : string

Returns a string that represents the current object.

Returns:string