Members

lagRemaining :number

CommandQueue.js, line 88

Seconds until the next command can be executed

msTilNextRun :number

CommandQueue.js, line 96

Milliseconds til the next command can be executed

queue :Array.<Object>

CommandQueue.js, line 59

Methods

addLag(amount)

CommandQueue.js, line 22

Safely add lag to the current queue. This method will not let you add a negative amount as a safety measure. If you want to subtract lag you can directly manipulate the lag property.

Parameters:

Name	Type	Description
amount	number	milliseconds of lag

enqueue(executable, lag)

CommandQueue.js, line 30

Parameters:

Name	Type	Description
executable	CommandExecutable	Thing to run with an execute and a queue label
lag	number	Amount of lag to apply to the queue after the command is run

execute() → {boolean}

CommandQueue.js, line 43

Execute the currently pending command if it's ready

Returns:

boolean -

whether the command was executed

flush()

CommandQueue.js, line 69

Flush all pending commands. Does not reset lastRun/lag. Meaning that if the queue is flushed after a command was just run its lag will still have to expire before another command can be run. To fully reset the queue use the reset() method.

getMsTilRun(commandIndex) → {number}

CommandQueue.js, line 115

Milliseconds until the command at the given index can be run

Parameters:

Name	Type	Description
commandIndex	number

Returns:

number

getTimeTilRun(commandIndex, milliseconds) → {number}

CommandQueue.js, line 106

For a given command index find how many seconds until it will run

Parameters:

Name	Type	Description
commandIndex	number
milliseconds	boolean

Returns:

number

reset()

CommandQueue.js, line 78

Completely reset the queue and any lag. This is fairly dangerous as if the player could reliably reset the queue they could negate any command lag. To clear commands without altering lag use flush()