Action
Description:
Represents an action that can be run on a node.
Class Object: Action Class.
Inherits from: Object.
duration
Type: Readonly Field.
Description:
The duration of the action.
Signature:
const duration: number
running
Type: Readonly Field.
Description:
Whether the action is currently running.
Signature:
const running: boolean
paused
Type: Readonly Field.
Description:
Whether the action is currently paused.
Signature:
const paused: boolean
reversed
Type: Field.
Description:
Whether the action should be run in reverse.
Signature:
reversed: boolean
speed
Type: Field.
Description:
The speed at which the action should be run. Set to 1.0 to get normal speed, Set to 2.0 to get two times faster.
Signature:
speed: number
pause
Type: Function.
Description:
Pauses the action.
Signature:
pause: function(self: Action)
resume
Type: Function.
Description:
Resumes the action.
Signature:
resume: function(self: Action)
updateTo
Type: Function.
Description:
Updates the state of the Action.
Signature:
updateTo: function(
self: Action,
elapsed: number,
reversed?: boolean --[[false]]
)
Parameters:
Parameter | Type | Description |
---|---|---|
elapsed | number | The amount of time in seconds that has elapsed to update action to. |
reversed | boolean | Whether or not to update the Action in reverse (default is false). |