GotoState - ScriptObject
From Creation Kit
Member of: ScriptObject
Sets this object's current state, issuing OnBeginState - ScriptObject and OnEndState - ScriptObject events as necessary.
Syntax
Function GotoState(string asNewState)
Parameters
- asNewState: The state to go to. Subsequent calls to GetState will return this string exactly as passed in. The state name is not case-sensitive.
Return Value
None.
Examples
; Set this object as being in the "Running" state GotoState("Running")
Notes
- GotoState doesn't return until the OnEndState - ScriptObject event of the current state and the OnBeginState - ScriptObject event of the new state finish running. (And the events won't overlap)
- If you call GotoState, and the script is already in the specified state, the OnEndState - ScriptObject and OnBeginState - ScriptObject events will still fire.
