Field Context - Revision history

Rob: /* Target References{{anchor|references}} */

2009-05-12T09:36:16Z

Target References{{anchor|references}}

← Older revision		Revision as of 09:36, 12 May 2009
Line 104:		Line 104:
	\|-		\|-
	\|modify[''oper'',''val'',''str'']		\|modify[''oper'',''val'',''str'']
	\|(Right, Number) Applies a modification to the field with accompanying notes for tracking a history of changes. The modification nature is given by the ''oper'' parameter, which ~~must be one of the standard arithmetic operators: '+', '-', '*', '/'. The '=' operator may also be specified,~~ which ~~will assign~~ the ~~new value~~ to ~~the field and ignore previous adjustments (only valid with "stack" or "changes" history tracking)~~. The ''val'' parameter is an arithmetic expression the provides the modification value to be applied. The ''str'' parameter is a text annotation that is recorded along with the modification. If ''str'' is the empty string, the notes are the name of the initial pick context that is applying the change (or "?????" if the initial context is not a pick). The field must be explicitly configured to support history tracking. Always returns a value of zero.<br>		\|(Right, Number) Applies a modification to the field with accompanying notes for tracking a history of changes. The modification nature is given by the ''oper'' parameter, which which specifies the operation to be performed. The ''val'' parameter is an arithmetic expression the provides the modification value to be applied. The ''str'' parameter is a text annotation that is recorded along with the modification. If ''str'' is the empty string, the notes are the name of the initial pick context that is applying the change (or "?????" if the initial context is not a pick). The ''oper'' parameter must be one of the following:
			<ul class="sets">
			<li>'+' - The value is added to the field.</li>
			<li>'-' - The value is subtracted from the field.</li>
			<li>'*' - The value is multiplied into the field.</li>
			<li>'/' - The value is divided into the field.</li>
			<li>'=' - The new value is assigned to the field and all previous adjustments to the field are ignored. This operator is only valid with "stack" or "changes" history tracking.</li>
			<li>'#' - The value is added to the field, but no sign is displayed for the field within the history report. This allows the identification of basic values included into the field calculation that are distinct from bonuses (which include the '+').</li>
			<li>'$' - The value is completely ignored and only the text entry is added for the modification. This allows a history entry to be recorded that has no value but that needs to be included in the report.</li>
			</ul>
			The field must be explicitly configured to support history tracking. Always returns a value of zero.<br>
	Example: perform this.field[myfield].modify[+,1,"first"]		Example: perform this.field[myfield].modify[+,1,"first"]
	\|-		\|-

Rob: /* Target References{{anchor|references}} */

2009-02-20T02:45:12Z

Target References{{anchor|references}}

← Older revision		Revision as of 02:45, 20 February 2009
Line 44:		Line 44:
	\|(Right, Number) Returns non-zero if the field contains the empty string and zero if it contains text of any length. If used on a numeric field or with an array or matrix, an error is reported. Testing of array and matrix elements must be done via the "compare" intrinsic.<br>		\|(Right, Number) Returns non-zero if the field contains the empty string and zero if it contains text of any length. If used on a numeric field or with an array or matrix, an error is reported. Testing of array and matrix elements must be done via the "compare" intrinsic.<br>
	Example: result = this.field[myfield].isempty		Example: result = this.field[myfield].isempty
			\|-
			\|ischanged
			\|(Right, Number) Returns non-zero if the field contents have been changed in any way from its original starting state. This can detect a field that has been changed by the user or via a script.<br>
			Example: result = this.field[myfield].ischanged
	\|-		\|-
	\|reset		\|reset

Rob: /* Target References{{anchor|references}} */

2009-02-20T02:18:24Z

Target References{{anchor|references}}

← Older revision		Revision as of 02:18, 20 February 2009
Line 110:		Line 110:
	<li>changes - Same as 'stack'</li>		<li>changes - Same as 'stack'</li>
	</ul>		</ul>
			Example: result = this.field[myfield].history<br>
			Example: result = this.field[myfield].history["&"]<br>
			Example: result = this.field[myfield].history[", ",42]
	\|-		\|-
	\|}		\|}

Rob: /* Target References{{anchor|references}} */

2009-02-20T02:16:45Z

Target References{{anchor|references}}

← Older revision		Revision as of 02:16, 20 February 2009
Line 103:		Line 103:
	Example: perform this.field[myfield].modify[+,1,"first"]		Example: perform this.field[myfield].modify[+,1,"first"]
	\|-		\|-
	\|history[''spl'']		\|history[''spl'',''start'']
	\|(Right, String) Generates and returns a text string that contains the change history for the field. The ''spl'' parameter is a string that is inserted between entries in the change history, splicing them together for appropriate output. The history report contents depend on the history behavior assigned to the field, as given below:		\|(Right, String) Generates and returns a text string that contains the change history for the field. The ''spl'' parameter is a string that is inserted between entries in the change history, splicing them together for appropriate output. The ''start'' parameter is the starting value used for the field within the report. Both the ''spl'' and ''start'' parameters are optional, although the ''spl'' is required in order to specify the ''start'' parameter. If omitted, the ''spl'' parameter defaults to a comma and a space (", "), while the ''start'' parameter defaults to zero. The history report contents depend on the history behavior assigned to the field, as given below:
	<ul class="sets">		<ul class="sets">
	<li>best – Only the notes text for each history entry is reported</li>		<li>best – Only the notes text for each history entry is reported</li>
	<li>stack – The notes text for each entry is reported and the adjustment details are included in parentheses with the notes (e.g. "notes (+2)")</li>		<li>stack – The notes text for each entry is reported and the adjustment details are included in parentheses with the notes (e.g. "notes (+2)")</li>
			<li>changes - Same as 'stack'</li>
	</ul>		</ul>
	\|-		\|-
	\|}		\|}

Rob: /* Target References{{anchor|references}} */

2009-02-20T02:09:27Z

Target References{{anchor|references}}

← Older revision		Revision as of 02:09, 20 February 2009
Line 100:		Line 100:
	\|-		\|-
	\|modify[''oper'',''val'',''str'']		\|modify[''oper'',''val'',''str'']
	\|(Right, Number) Applies a modification to the field with accompanying notes for tracking a history of changes. The modification nature is given by the ''oper'' parameter, which must be one of the standard arithmetic operators: '+', '-', '*', '/'. The ''val'' parameter is an arithmetic expression the provides the modification value to be applied. The ''str'' parameter is a text annotation that is recorded along with the modification. If ''str'' is the empty string, the notes are the name of the initial pick context that is applying the change (or "?????" if the initial context is not a pick). The field must be explicitly configured to support history tracking. Always returns a value of zero.<br>		\|(Right, Number) Applies a modification to the field with accompanying notes for tracking a history of changes. The modification nature is given by the ''oper'' parameter, which must be one of the standard arithmetic operators: '+', '-', '*', '/'. The '=' operator may also be specified, which will assign the new value to the field and ignore previous adjustments (only valid with "stack" or "changes" history tracking). The ''val'' parameter is an arithmetic expression the provides the modification value to be applied. The ''str'' parameter is a text annotation that is recorded along with the modification. If ''str'' is the empty string, the notes are the name of the initial pick context that is applying the change (or "?????" if the initial context is not a pick). The field must be explicitly configured to support history tracking. Always returns a value of zero.<br>
	Example: perform this.field[myfield].modify[+,1,"first"]		Example: perform this.field[myfield].modify[+,1,"first"]
	\|-		\|-

Rob: /* Target References{{anchor|references}} */

2008-12-21T00:14:59Z

Target References{{anchor|references}}

@@ Line 87: / Line 87: @@
 Example: result = this.field[myfield].matrixdump<br>
 {{note}}The generated output is capped to the limits of the debug output mechanism, so using this mechanism with large matrices and/or text-based fields may result in the output being truncated.
 |-
 |modify[''oper'',''val'',''str'']

Rob at 23:27, 7 December 2008

2008-12-07T23:27:29Z

← Older revision		Revision as of 23:27, 7 December 2008
Line 11:		Line 11:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|state		\|class="leftnormal"\|state
	\|Transitions to the [[State Context~~#transitions~~\|state context]].<br>		\|Transitions to the [[State Context\|state context]].<br>
	Example: this.state		Example: this.state
	\|-		\|-
	\|pick		\|pick
	\|Transitions to the [[Pick Context~~#transitions~~\|pick context]] corresponding to the pick that contains the current field.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the pick that contains the current field.<br>
	Example: this.pick		Example: this.pick
	\|-		\|-
	\|chosen		\|chosen
	\|Transitions to either the [[Pick Context~~#transitions~~\|pick context]] corresponding to the user-selected pick stored within the field or the [[Thing Context~~#transitions~~\|thing context]] corresponding to the user-selected thing stored within the field, depending on the nature of the field. The transition is only valid for use on fields that store menu selections made by the user.<br>		\|Transitions to either the [[Pick Context\|pick context]] corresponding to the user-selected pick stored within the field or the [[Thing Context\|thing context]] corresponding to the user-selected thing stored within the field, depending on the nature of the field. The transition is only valid for use on fields that store menu selections made by the user.<br>
	Example: this.chosen		Example: this.chosen
	\|-		\|-

Rob: Field Context Transitions moved to Field Context

2008-12-07T23:24:13Z

Field Context Transitions moved to Field Context

← Older revision	Revision as of 23:24, 7 December 2008
(No difference)

Rob: /* Context Transitions{{anchor|transitions}} */

2008-12-07T23:23:33Z

Context Transitions{{anchor|transitions}}

← Older revision		Revision as of 23:23, 7 December 2008
Line 19:		Line 19:
	\|-		\|-
	\|chosen		\|chosen
	\|Transitions to either the [[Pick Context#transitions\|pick context]] corresponding to the user-selected pick stored within the field or the [[Thing Context ~~Transitions~~\|thing context]] corresponding to the user-selected thing stored within the field, depending on the nature of the field. The transition is only valid for use on fields that store menu selections made by the user.<br>		\|Transitions to either the [[Pick Context#transitions\|pick context]] corresponding to the user-selected pick stored within the field or the [[Thing Context#transitions\|thing context]] corresponding to the user-selected thing stored within the field, depending on the nature of the field. The transition is only valid for use on fields that store menu selections made by the user.<br>
	Example: this.chosen		Example: this.chosen
	\|-		\|-

Rob at 23:22, 7 December 2008

2008-12-07T23:22:44Z

@@ Line 1: / Line 1: @@
-{{context|Kit Reference|Context Transitions}}
+{{contextmulti|Kit Reference}}
-See Also: [[Field Target References]]
+Jump to: [[#references|Target References]]
 From within a "field" context, you can utilize the following set of valid context transitions:
@@ Line 7: / Line 11: @@
 :{| class="infotable"
 |class="leftnormal"|state
-|Transitions to the [[State Context Transitions|state context]].<br>
+|Transitions to the [[State Context#transitions|state context]].<br>
 Example: this.state
 |-
 |pick
-|Transitions to the [[Pick Context Transitions|pick context]] corresponding to the pick that contains the current field.<br>
+|Transitions to the [[Pick Context#transitions|pick context]] corresponding to the pick that contains the current field.<br>
 Example: this.pick
 |-
 |chosen
-|Transitions to either the [[Pick Context Transitions|pick context]] corresponding to the user-selected pick stored within the field or the [[Thing Context Transitions|thing context]] corresponding to the user-selected thing stored within the field, depending on the nature of the field. The transition is only valid for use on fields that store menu selections made by the user.<br>
+|Transitions to either the [[Pick Context#transitions|pick context]] corresponding to the user-selected pick stored within the field or the [[Thing Context Transitions|thing context]] corresponding to the user-selected thing stored within the field, depending on the nature of the field. The transition is only valid for use on fields that store menu selections made by the user.<br>
 Example: this.chosen
 |-
 |}