GotoState function - ScriptObject script | Starfield

Found in:

voidfunctionGotoState(stringasNewState)

Description

Sets this object's current state, issuing OnBeginState - ScriptObject and OnEndState - ScriptObject events as necessary.

Sets the script's current state, calling the appropriate end/begin state events

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.

stringasNewState
CK Wiki Description
The state to go to. Subsequent calls to GetState will return this string exactly as passed in. The state name is not case-sensitive.

; Set this object as being in the "Running" state
GotoState("Running")

string myString__asNewState

myScriptObject__toCallFunctionOn.GotoState(myString__asNewState)