State Target References - Revision history

Rob at 13:19, 7 December 2008

2008-12-07T13:19:09Z

← Older revision		Revision as of 13:19, 7 December 2008
Line 1:		Line 1:
	{{context\|Kit Reference\|Target References}}		{{context\|Kit Reference\|Target References}}

			See Also: [[State Context Transitions]]

	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.		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.

Rob at 08:32, 7 December 2008

2008-12-07T08:32:00Z

← Older revision		Revision as of 08:32, 7 December 2008
Line 33:		Line 33:
	\|-		\|-
	\|isoutput		\|isoutput
	\|(Right, Number) Returns non-zero if rendering of character sheet output is currently in progress.<br>		\|(Right, Number) Returns non-zero if the rendering of character sheet output is currently in progress.<br>
	Example: result = state.isoutput		Example: result = state.isoutput
	\|-		\|-
	\|isdossierstyle[''style'']		\|isdossierstyle[''style'']
	\|(Right, Number) <br>		\|(Right, Number) Returns whether the user selected text output to be formatted in the style given by the ''style'' parameter. The ''style'' parameter must be one of the following values: "plain", "html", or "bbcode".<br>
	Example: result =		Example: result = state.isdossierstyle[html]
	\|-		\|-
	\|~~statblock~~		\|istext
	\|(Right, Number) <br>		\|(Right, Number) Returns non-zero if the render of text output is currently in progress.<br>
	Example: result =		Example: result = state.istext
	\|-		\|-
	\|iscombat		\|iscombat
	\|(Right, Number) <br>		\|(Right, Number) Returns non-zero if combat mode is currently enabled within the Tactical Console.<br>
	Example: result =		Example: result = state.iscombat
	\|-		\|-
	\|isendturn		\|isendturn
	\|(Right, Number) <br>		\|(Right, Number) Returns non-zero if all combatants have taken their allotted actions and it is valid to end the current combat turn.<br>
	Example: result =		Example: result = state.isendturn
	\|-		\|-
	\|combatturn		\|combatturn
	\|(Right, Number) <br>		\|(Right, Number) Returns the current combat turn that is underway within the Tactical Console.<br>
	Example: result =		Example: result = state.combatturn
	\|-		\|-
	\|initchange		\|initchange
	\|(Right, Number) <br>		\|(Right, Number) Returns non-zero if any actor has a user-modified initiative value.<br>
	Example: result =		Example: result = state.initchange
	\|-		\|-
	\|actorcount		\|actorcount
	\|(Right, Number) <br>		\|(Right, Number) Returns the total number of actors within the portfolio, including all minions.<br>
	Example: result =		Example: result = state.actorcount
	\|-		\|-
	\|reload[''table'']		\|reload[''table'']
	\|(Right, Number) <br>		\|(Right, Number) Forces a re-load and re-sort of the table portal whose id is given by the ''table'' parameter. This target reference is only accessible from within a [[Trigger Script]].<br>
	Example: result =		Example: result = state.reload[myportal]
	\|-		\|-
	\|}		\|}

Rob at 08:23, 7 December 2008

2008-12-07T08:23:04Z

← Older revision		Revision as of 08:23, 7 December 2008
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'']

Rob at 08:14, 7 December 2008

2008-12-07T08:14:48Z

← Older revision		Revision as of 08:14, 7 December 2008
Line 4:		Line 4:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|~~output~~		\|class="leftnormal"\|isfocus
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~load~~		\|clearfocus
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~statblock~~		\|timing
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~combatturn~~		\|isoutput
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~initchange~~		\|isload
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~isfocus~~		\|iscreate
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~clearfocus~~		\|isadvance
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
Line 36:		Line 36:
	Example: result =		Example: result =
	\|-		\|-
	\|~~iscreate~~		\|isdossierstyle[''style'']
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~isadvance~~		\|statblock
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~timing~~		\|iscombat
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~actorcount~~		\|isendturn
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~iscombat~~		\|combatturn
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~isendturn~~		\|initchange
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =
	\|-		\|-
	\|~~isdossierstyle[''style'']~~		\|actorcount
	\|(Right, Number) <br>		\|(Right, Number) <br>
	Example: result =		Example: result =

Rob: New page: {{context|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 s...

2008-12-07T08:09:58Z

New page: {{context|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 s...

New page

{{context|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.

:{| class="infotable"
|class="leftnormal"|output
|(Right, Number) 
Example: result =
|-
|load
|(Right, Number) 
Example: result =
|-
|statblock
|(Right, Number) 
Example: result =
|-
|combatturn
|(Right, Number) 
Example: result =
|-
|initchange
|(Right, Number) 
Example: result =
|-
|isfocus
|(Right, Number) 
Example: result =
|-
|clearfocus
|(Right, Number) 
Example: result =
|-
|issell
|(Right, Number) 
Example: result =
|-
|iscreate
|(Right, Number) 
Example: result =
|-
|isadvance
|(Right, Number) 
Example: result =
|-
|timing
|(Right, Number) 
Example: result =
|-
|actorcount
|(Right, Number) 
Example: result =
|-
|iscombat
|(Right, Number) 
Example: result =
|-
|isendturn
|(Right, Number) 
Example: result =
|-
|isdossierstyle[''style'']
|(Right, Number) 
Example: result =
|-
|reload[''table'']
|(Right, Number) 
Example: result =
|-
|}