Process
Defined in: Process.ts:22
A Process represents an ongoing action updated each frame. Used internally by Tween and Sequence, and directly for custom coroutines.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Process(
options):Process
Defined in: Process.ts:45
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Process
Properties
Section titled “Properties”
readonlytags: readonlystring[]
Defined in: Process.ts:29
Tags for filtering/grouping.
Accessors
Section titled “Accessors”completed
Section titled “completed”Get Signature
Section titled “Get Signature”get completed():
boolean
Defined in: Process.ts:54
Whether the process has completed.
Returns
Section titled “Returns”boolean
paused
Section titled “paused”Get Signature
Section titled “Get Signature”get paused():
boolean
Defined in: Process.ts:59
Whether the process is paused.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”_reset()
Section titled “_reset()”_reset():
void
Defined in: Process.ts:123
Internal
Reset the process to its initial state so it can be re-run. Used by Sequence for loop/repeat with direct instances.
Returns
Section titled “Returns”void
_update()
Section titled “_update()”_update(
dt):void
Defined in: Process.ts:92
Internal
Advance the process by dt milliseconds.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
cancel()
Section titled “cancel()”cancel():
void
Defined in: Process.ts:74
Cancel the process.
Returns
Section titled “Returns”void
pause()
Section titled “pause()”pause():
void
Defined in: Process.ts:64
Pause the process.
Returns
Section titled “Returns”void
resume()
Section titled “resume()”resume():
void
Defined in: Process.ts:69
Resume the process.
Returns
Section titled “Returns”void
toPromise()
Section titled “toPromise()”toPromise():
Promise<void>
Defined in: Process.ts:81
Returns a promise that resolves when the process completes or is cancelled.
Returns
Section titled “Returns”Promise<void>
delay()
Section titled “delay()”
staticdelay(duration,onComplete?,tags?):Process
Defined in: Process.ts:38
Create a timer that fires onComplete after duration ms.
Parameters
Section titled “Parameters”duration
Section titled “duration”number
onComplete?
Section titled “onComplete?”() => void
string[]
Returns
Section titled “Returns”Process