State Target References
Context: HL Kit … Kit Reference … Target References
The "state" context is a general context that maintains information outside the normal data hierarchy. The target references for this context span a wide range of details that may prove useful within your scripts. The complete list of target references for the "state" context is presented in the table below.
isfocus (Right, Number) Returns non-zero if a focus pick has been properly established via the "setfocus" target reference.
Example: result = state.isfocus
clearfocus (Right, Number) Clears any focus pick that has been established and resets to a state where there is no focus pick.
Example: perform state.clearfocus
timing (Right, String) Returns the phase and priority timing during which the current script is being invoked in an effort to simplify debugging of data files.
Example: result = state.timing
iscreate (Right, Number) Returns non-zero if the character is currently in creation mode.
Example: result = state.iscreate
isadvance (Right, Number) Returns non-zero if the character is currently in advancement mode.
Example: result = state.isadvance
issell (Right, Number) Returns non-zero if the user is currently in the midst of a sell transaction.
Example: result = state.issell
isload (Right, Number) Returns non-zero if the loading of a saved portfolio is currently in progress.
Example: result = state.isload
isoutput (Right, Number) Returns non-zero if rendering of character sheet output is currently in progress.
Example: result = state.isoutput
isdossierstyle[style] (Right, Number)
Example: result =
statblock (Right, Number)
Example: result =
iscombat (Right, Number)
Example: result =
isendturn (Right, Number)
Example: result =
combatturn (Right, Number)
Example: result =
initchange (Right, Number)
Example: result =
actorcount (Right, Number)
Example: result =
reload[table] (Right, Number)
Example: result =
