Difference between revisions of "GetState - All Scripts"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
 
(added note about latency)
Line 23: Line 23:
endIf
endIf
</source>
</source>
== Notes ==
* This is a latent function and is not executed asynchronously.


== See Also ==
== See Also ==

Revision as of 16:53, 1 April 2022

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.

See Also