State Target References: Difference between revisions

From HLKitWiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 5: Line 5:
:{| class="infotable"
:{| class="infotable"
|class="leftnormal"|isfocus
|class="leftnormal"|isfocus
|(Right, Number) <br>
|(Right, Number) Returns non-zero if a focus pick has been properly established via the "setfocus" target reference.<br>
Example: result =  
Example: result = state.isfocus
|-
|-
|clearfocus
|clearfocus
|(Right, Number) <br>
|(Right, Number) Clears any focus pick that has been established and resets to a state where there is no focus pick.<br>
Example: result =
Example: perform state.clearfocus
|-
|-
|timing
|timing
|(Right, Number) <br>
|(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.<br>
Example: result =
Example: result = state.timing
|-
|isoutput
|(Right, Number) <br>
Example: result =
|-
|isload
|(Right, Number) <br>
Example: result =  
|-
|-
|iscreate
|iscreate
|(Right, Number) <br>
|(Right, Number) Returns non-zero if the character is currently in creation mode.<br>
Example: result =  
Example: result = state.iscreate
|-
|-
|isadvance
|isadvance
|(Right, Number) <br>
|(Right, Number) Returns non-zero if the character is currently in advancement mode.<br>
Example: result =  
Example: result = state.isadvance
|-
|-
|issell
|issell
|(Right, Number) <br>
|(Right, Number) Returns non-zero if the user is currently in the midst of a sell transaction.<br>
Example: result =  
Example: result = state.issell
|-
|isload
|(Right, Number) Returns non-zero if the loading of a saved portfolio is currently in progress.<br>
Example: result = state.isload
|-
|isoutput
|(Right, Number) Returns non-zero if rendering of character sheet output is currently in progress.<br>
Example: result = state.isoutput
|-
|-
|isdossierstyle[''style'']
|isdossierstyle[''style'']

Revision as of 08:23, 7 December 2008

Context: HL Kit &#133; Kit Reference &#133; 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 =