Difference between revisions of "GetState - All Scripts"
Jump to navigation
Jump to search
(added note about latency) |
(Added comment about skyui states) |
||
| Line 26: | Line 26: | ||
== Notes == | == Notes == | ||
* This is a latent function and is not executed asynchronously. | * This is a latent function and is not executed asynchronously. | ||
*When used inside a SkyUI "[https://github.com/schlangster/skyui/wiki/MCM-State-Options state option"] event, the name of the state option's state is returned. | |||
== See Also == | == See Also == | ||
Latest revision as of 17:07, 3 April 2022
Member of: Any and all scripts.
Obtains the current state of the script, as a string.
Syntax[edit | edit source]
string Function GetState()Parameters[edit | edit source]
None
Return Value[edit | edit source]
The script's current state, as it was last set by a GotoState call.
Examples[edit | edit source]
; Is this object currently in the "Running" state?
if (GetState() == "Running") ; case-sensitive!
Debug.Trace("We are currently in the running state")
endIfNotes[edit | edit source]
- 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.