GetState - All Scripts
Member of: Any and all scripts.
Obtains the current state of the script, as a string.
SyntaxEdit
string Function GetState()
ParametersEdit
None
Return ValueEdit
The script's current state, as it was last set by a GotoState call.
ExamplesEdit
; Is this object currently in the "Running" state?
if (GetState() == "Running") ; case-sensitive!
Debug.Trace("We are currently in the running state")
endIf
NotesEdit
- 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.