Template Context - Revision history

Colen at 05:42, 20 December 2013

2013-12-20T05:42:30Z

← Older revision		Revision as of 05:42, 20 December 2013
Line 149:		Line 149:
	Example: perform this.autoplace[42]<br>		Example: perform this.autoplace[42]<br>
	Example: perform this.autoplace		Example: perform this.autoplace
			\|-
			\|batchadd[''gap'']
			\|(Right, Number) Queues the template for batch placement within the containing layout, subject to the standard rules for [[Using Batch Placement\|batch placement]]. As with "autoplace", the ''gap'' parameter specifies the gap to be used between this template and the previous placed element. The parameter can be omitted, in which case the established "autogap" is utilized. Batch placement for templates can only be used within layouts. A value of zero is always returned.<br>
			Example: perform this.batchadd[42]<br>
			Example: perform this.batchadd
	\|-		\|-
	\|}		\|}

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

2009-06-08T20:27:54Z

Target References{{anchor|references}}

@@ Line 144: / Line 144: @@
 |(Right, Number) Returns non-zero if the indicated identity tag has been assigned to the pick/thing associated with the template. The identity tag sought must be from the tag group ''grp'' and the tag id is dictated by the initial context of the script. For more details, [[Identity Target References|please check here]].<br>
 Example: result = this.isidentity[groupid]
 |-
 |autoplace[''gap'']

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

2009-02-20T10:04:09Z

Target References{{anchor|references}}

← Older revision		Revision as of 10:04, 20 February 2009
Line 76:		Line 76:
	Example: result = this.visible<br>		Example: result = this.visible<br>
	Example: this.visible = 1		Example: this.visible = 1
			\|-
			\|isroot
			\|(Right, Number) Returns non-zero if the pick associated with the template has been bootstrapped and therefore has a root pick available. If the pick is associated with a thing, zero is returned.<br>
			Example: result = this.isroot
	\|-		\|-
	\|issizing		\|issizing

Rob: Template Context Transitions moved to Template Context

2008-12-07T23:36:24Z

Template Context Transitions moved to Template Context

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

Rob at 23:36, 7 December 2008

2008-12-07T23:36:06Z

Show changes

Rob at 23:34, 7 December 2008

2008-12-07T23:34:59Z

← Older revision		Revision as of 23:34, 7 December 2008
Line 1:		Line 1:
	{{~~context~~\|Kit Reference~~\|Context Transitions~~}}		{{contextmulti\|Kit Reference}}

	~~See Also~~: [[~~Template~~ Target References]]		Jump to: [[#references\|Target References]]

			The "template" context identifies a template within the current hierarchy. Templates can either be used within layouts or within tables, so the parent context of the template within the hierarchy can vary.

			==Context Transitions{{anchor\|transitions}}==

	From within a "template" context, you can utilize the following set of valid context transitions:		From within a "template" context, you can utilize the following set of valid context transitions:
Line 7:		Line 11:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|parent		\|class="leftnormal"\|parent
	\|Transitions to the [[Layout Context ~~Transitions~~\|layout context]] or [[~~#table~~\|table context]] corresponding to the visual element that contains the tmeplate.<br>		\|Transitions to the [[Layout Context\|layout context]] or [[Table Context\|table context]] corresponding to the visual element that contains the tmeplate.<br>
	Example: this.parent<br>		Example: this.parent<br>
	{{note}}The "parent" transition can only be utilized a '''single''' time, so it is not possible to go upwards two or more levels within the hierarchy.		{{note}}The "parent" transition can only be utilized a '''single''' time, so it is not possible to go upwards two or more levels within the hierarchy.
	\|-		\|-
	\|portal[''id'']		\|portal[''id'']
	\|Transitions to the [[Portal Context ~~Transitions~~\|portal context]] corresponding to the portal within the current template that possesses the ''id'' specified. If the portal does not exist within the template, the transition fails to resolve.<br>		\|Transitions to the [[Portal Context\|portal context]] corresponding to the portal within the current template that possesses the ''id'' specified. If the portal does not exist within the template, the transition fails to resolve.<br>
	Example: this.portal[myportal]<br>		Example: this.portal[myportal]<br>
	{{note}}Only portals defined directly within the template can be accessed via this transition.		{{note}}Only portals defined directly within the template can be accessed via this transition.
	\|-		\|-
	\|field[''id'']		\|field[''id'']
	\|Transitions to the [[Value Context ~~Transitions~~\|value context]] corresponding to the field within the current template that has the ''id'' specified. The fields for a template are dictated by the pick or thing that is associated with the template. If the given field does not exist for the pick/thing, the transition fails to resolve.<br>		\|Transitions to the [[Value Context\|value context]] corresponding to the field within the current template that has the ''id'' specified. The fields for a template are dictated by the pick or thing that is associated with the template. If the given field does not exist for the pick/thing, the transition fails to resolve.<br>
	Example: this.field[myfield]<br>		Example: this.field[myfield]<br>
	{{note}}Within templates, all fields are treated as read-only, which is controlled by transitioning to a distinct "value" context instead of "field" context.		{{note}}Within templates, all fields are treated as read-only, which is controlled by transitioning to a distinct "value" context instead of "field" context.
	\|-		\|-
	\|container		\|container
	\|Transitions to the [[Container Context ~~Transitions~~\|container context]] corresponding to the container to which the template applies, whether it be an actor or a gizmo.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the container to which the template applies, whether it be an actor or a gizmo.<br>
	Example: this.container<br>		Example: this.container<br>
	{{note}}After transitioning, access within the new container context will be read-only and limited in what information can be retrieved.<br>		{{note}}After transitioning, access within the new container context will be read-only and limited in what information can be retrieved.<br>
Line 28:		Line 32:
	\|-		\|-
	\|hero		\|hero
	\|Transitions to the [[Hero Context ~~Transitions~~\|hero context]] corresponding to the hero to which the template applies.<br>		\|Transitions to the [[Hero Context\|hero context]] corresponding to the hero to which the template applies.<br>
	Example: this.hero<br>		Example: this.hero<br>
	{{note}}After transitioning, access within the new hero context will be read-only and limited in what information can be retrieved.<br>		{{note}}After transitioning, access within the new hero context will be read-only and limited in what information can be retrieved.<br>

Rob: New page: {{context|Kit Reference|Context Transitions}} See Also: Template Target References From within a "template" context, you can utilize the following set of valid context transitions: ...

2008-12-07T13:08:42Z

New page: {{context|Kit Reference|Context Transitions}} See Also: Template Target References From within a "template" context, you can utilize the following set of valid context transitions: ...

New page

{{context|Kit Reference|Context Transitions}}

See Also: [[Template Target References]]

From within a "template" context, you can utilize the following set of valid context transitions:

:{| class="infotable"
|class="leftnormal"|parent
|Transitions to the [[Layout Context Transitions|layout context]] or [[#table|table context]] corresponding to the visual element that contains the tmeplate. 
Example: this.parent 
{{note}}The "parent" transition can only be utilized a '''single''' time, so it is not possible to go upwards two or more levels within the hierarchy.
|-
|portal[''id'']
|Transitions to the [[Portal Context Transitions|portal context]] corresponding to the portal within the current template that possesses the ''id'' specified. If the portal does not exist within the template, the transition fails to resolve. 
Example: this.portal[myportal] 
{{note}}Only portals defined directly within the template can be accessed via this transition.
|-
|field[''id'']
|Transitions to the [[Value Context Transitions|value context]] corresponding to the field within the current template that has the ''id'' specified. The fields for a template are dictated by the pick or thing that is associated with the template. If the given field does not exist for the pick/thing, the transition fails to resolve. 
Example: this.field[myfield] 
{{note}}Within templates, all fields are treated as read-only, which is controlled by transitioning to a distinct "value" context instead of "field" context.
|-
|container
|Transitions to the [[Container Context Transitions|container context]] corresponding to the container to which the template applies, whether it be an actor or a gizmo. 
Example: this.container 
{{note}}After transitioning, access within the new container context will be read-only and limited in what information can be retrieved. 
{{note}}This transition can only be used as the '''first''' transition when within a visual script.
|-
|hero
|Transitions to the [[Hero Context Transitions|hero context]] corresponding to the hero to which the template applies. 
Example: this.hero 
{{note}}After transitioning, access within the new hero context will be read-only and limited in what information can be retrieved. 
{{note}}This transition can only be used as the '''first''' transition when within a visual script.
|-
|}