NewTurn Script - Revision history

Rob: /* Technical Details */

2009-02-20T08:59:49Z

Technical Details

← Older revision		Revision as of 08:59, 20 February 2009
Line 15:		Line 15:
	\|Where Used:		\|Where Used:
	\|[[Behavior Element (Data)\|Definition File]]		\|[[Behavior Element (Data)\|Definition File]]
			\|-
			\|Procedure Use:
			\|"newturn" type, "pick" context
	\|-		\|-
	\|}		\|}

Rob at 07:52, 20 February 2009

2009-02-20T07:52:19Z

← Older revision		Revision as of 07:52, 20 February 2009
Line 21:		Line 21:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|~~-None-~~		\|class="leftnormal"\|isfirst
	\|~~There are no special symbols~~ for ~~a NewTurn script~~.		\|(Number) Entry: Non-zero if this script is being invoked for the first actor in the portfolio.<br>
			Exit: Ignored.
	\|-		\|-
	\|}		\|}
Line 28:		Line 29:
	==Description==		==Description==

	The NewTurn script is invoked whenever the user triggers the start of a new combat turn within the Tactical Console. Prior to the start of the new turn, this script is applied to each actor. When invoked, the NewTurn script starts with the "actor" pick of an actor in the combat as its initial context. It is invoked for all actors in the combat (non-combatants are ignored). This allows the author to reset state for each actor prior to each new combat turn.		The NewTurn script is invoked whenever the user triggers the start of a new combat turn within the Tactical Console. Prior to the start of the new turn, this script is applied to each actor. When invoked, the NewTurn script starts with the "actor" pick of an actor in the combat as its initial context. It is invoked for all actors in the combat (non-combatants are ignored), being performed after any NewCombat script and before any Initiative script. This allows the author to reset state for each actor prior to each new combat turn.

	==Example==		==Example==

Rob at 00:20, 16 December 2008

2008-12-16T00:20:41Z

← Older revision		Revision as of 00:20, 16 December 2008
Line 12:		Line 12:
	\|Fields Finalized?		\|Fields Finalized?
	\|No		\|No
			\|-
			\|Where Used:
			\|[[Behavior Element (Data)\|Definition File]]
	\|-		\|-
	\|}		\|}

Rob at 12:41, 14 December 2008

2008-12-14T12:41:53Z

← Older revision		Revision as of 12:41, 14 December 2008
Line 25:		Line 25:
	==Description==		==Description==

	The NewTurn script is invoked whenever the user triggers the start of a new combat turn within the Tactical Console. Prior to the start of the new turn, this script is applied to each actor. When invoked, the NewTurn script starts with the "actor" pick of ~~each~~ actor in the combat as its initial context (non-combatants are ignored). This allows the author to reset state for each actor prior to each new combat turn.		The NewTurn script is invoked whenever the user triggers the start of a new combat turn within the Tactical Console. Prior to the start of the new turn, this script is applied to each actor. When invoked, the NewTurn script starts with the "actor" pick of an actor in the combat as its initial context. It is invoked for all actors in the combat (non-combatants are ignored). This allows the author to reset state for each actor prior to each new combat turn.

	==Example==		==Example==

Rob: New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

2008-12-14T12:15:25Z

New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

:{| class="scripttable"
|class="leftnormal"|Initial Context:
|[[Pick Context|Pick]]
|-
|Alternate Context:
|None
|-
|Fields Finalized?
|No
|-
|}

The NewTurn script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|-None-
|There are no special symbols for a NewTurn script.
|-
|}

==Description==

The NewTurn script is invoked whenever the user triggers the start of a new combat turn within the Tactical Console. Prior to the start of the new turn, this script is applied to each actor. When invoked, the NewTurn script starts with the "actor" pick of each actor in the combat as its initial context (non-combatants are ignored). This allows the author to reset state for each actor prior to each new combat turn.

==Example==

If a game system has state for each actor that needs to be reset at the start of each new combat turn, that can be accomplished via the NewTurn script.

<pre>
herofield[acState].value = 0
</pre>