GetState - All Scripts

Member of: Any and all scripts.

Obtains the current state of the script, as a string.

Syntax

string Function GetState()

Parameters

None

Return Value

The script's current state, as it was last set by a GotoState call.

Examples

; Is this object currently in the "Running" state?
if (GetState() == "Running") ; case-sensitive!
  Debug.Trace("We are currently in the running state")
endIf

Notes

• This is a latent function and is not executed asynchronously.
• When used inside a SkyUI "state option" event, the name of the state option's state is returned.

See Also

• GotoState - All Scripts
• OnBeginState
• OnEndState