Template Target References - Revision history

Colen at 05:41, 20 December 2013

2013-12-20T05:41:21Z

← Older revision		Revision as of 05:41, 20 December 2013
Line 110:		Line 110:
	\|batchadd[''gap'']		\|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>		\|(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.~~batchplace~~[42]<br>		Example: perform this.batchadd[42]<br>
	Example: perform this.~~batchplace~~		Example: perform this.batchadd
	\|-		\|-
	\|}		\|}

Colen at 05:41, 20 December 2013

2013-12-20T05:41:03Z

← Older revision		Revision as of 05:41, 20 December 2013
Line 108:		Line 108:
	Example: perform this.autoplace		Example: perform this.autoplace
	\|-		\|-
	\|~~batchplace~~[''gap'']		\|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>		\|(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.batchplace[42]<br>		Example: perform this.batchplace[42]<br>

Colen at 05:40, 20 December 2013

2013-12-20T05:40:49Z

← Older revision		Revision as of 05:40, 20 December 2013
Line 107:		Line 107:
	Example: perform this.autoplace[42]<br>		Example: perform this.autoplace[42]<br>
	Example: perform this.autoplace		Example: perform this.autoplace
			\|-
			\|batchplace[''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.batchplace[42]<br>
			Example: perform this.batchplace
	\|-		\|-
	\|}		\|}

Colen at 20:27, 8 June 2009

2009-06-08T20:27:09Z

@@ Line 102: / Line 102: @@
 |(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 at 13:17, 7 December 2008

2008-12-07T13:17:40Z

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

			See Also: [[Template Context Transitions]]

	The "template" script context governs the operations that can be applied to templates within layouts and tables. The complete list of target references for templates is presented in the table below.		The "template" script context governs the operations that can be applied to templates within layouts and tables. The complete list of target references for templates is presented in the table below.

Rob at 07:53, 7 December 2008

2008-12-07T07:53:02Z

← Older revision		Revision as of 07:53, 7 December 2008
Line 37:		Line 37:
	Example: this.visible = 1		Example: this.visible = 1
	\|-		\|-
	\|~~scrollbar~~		\|issizing
	\|(Right, Number) Returns non-zero if the "sizing" logic of a template within a table is being performed. This allows detection of the sizing logic so that all non-sizing behaviors can be skipped for the template.<br>		\|(Right, Number) Returns non-zero if the "sizing" logic of a template within a table is being performed. This allows detection of the sizing logic so that all non-sizing behaviors can be skipped for the template.<br>
	Example: result = this.issizing		Example: result = this.issizing

Rob at 07:48, 7 December 2008

2008-12-07T07:48:33Z

← Older revision		Revision as of 07:48, 7 December 2008
Line 37:		Line 37:
	Example: this.visible = 1		Example: this.visible = 1
	\|-		\|-
	~~{ "issizing", READONLY, 0, false },~~
	~~{ "inheader", READONLY, 0, false }~~
	\|scrollbar		\|scrollbar
	\|(Right, Number) Returns non-zero if the "sizing" logic of a template within a table is being performed. This allows detection of the sizing logic so that all non-sizing behaviors can be skipped for the template.<br>		\|(Right, Number) Returns non-zero if the "sizing" logic of a template within a table is being performed. This allows detection of the sizing logic so that all non-sizing behaviors can be skipped for the template.<br>
Line 52:		Line 50:
	\|-		\|-
	\|tagis[''tmpl'']		\|tagis[''tmpl'']
	\|(Right, Number) Returns non-zero if any tags assigned to the pick match the tag template ''tmpl'', else zero if no tags match. The template must use the standard "group.id" syntax and may contain a wildcard.<br>		\|(Right, Number) Returns non-zero if any tags assigned to the pick/thing associated with the template that match the tag template ''tmpl'', else zero if no tags match. The tag template must use the standard "group.id" syntax and may contain a wildcard.<br>
	Example: this.tagis[skill.?]		Example: this.tagis[skill.?]
	\|-		\|-
	\|tagcount[''tmpl'']		\|tagcount[''tmpl'']
	\|(Right, Number) Returns the number of tags assigned to the thing that match the tag template ''tmpl''. The template must use the standard "group.id" syntax and may contain a wildcard.<br>		\|(Right, Number) Returns the number of tags assigned to the pick/thing associated with the template that match the tag template ''tmpl''. The tag template must use the standard "group.id" syntax and may contain a wildcard.<br>
	Example: result = this.tagcount[skill.?]		Example: result = this.tagcount[skill.?]
	\|-		\|-
	\|tagvalue[''tmpl'']		\|tagvalue[''tmpl'']
	\|(Right, Number) Returns the value of a tag assigned to the thing that matches the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The template must use the standard "group.id" syntax and may contain a wildcard.<br>		\|(Right, Number) Returns the value of a tag assigned to the pick/thing associated with the template that matches the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The tag template must use the standard "group.id" syntax and may contain a wildcard.<br>
	Example: result = this.tagvalue[spelllevel.wizard?]		Example: result = this.tagvalue[spelllevel.wizard?]
	\|-		\|-
	\|tagmin[''tmpl'']		\|tagmin[''tmpl'']
	\|(Right, Number) Returns the minimum value of all tags assigned to the thing that match the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The template must use the standard "group.id" syntax and may contain a wildcard.<br>		\|(Right, Number) Returns the minimum value of all tags assigned to the pick/thing associated with the template that match the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The tag template must use the standard "group.id" syntax and may contain a wildcard.<br>
	Example: result = this.tagmin[spelllevel.wizard?]		Example: result = this.tagmin[spelllevel.wizard?]
	\|-		\|-
	\|tagmax[''tmpl'']		\|tagmax[''tmpl'']
	\|(Right, Number) Returns the maximum value of all tags assigned to the thing that match the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The template must use the standard "group.id" syntax and may contain a wildcard.<br>		\|(Right, Number) Returns the maximum value of all tags assigned to the pick/thing associated with the template that match the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The tag template must use the standard "group.id" syntax and may contain a wildcard.<br>
	Example: result = this.tagmax[spelllevel.wizard?]		Example: result = this.tagmax[spelllevel.wizard?]
	\|-		\|-
	\|tagunique[''tmpl'']		\|tagunique[''tmpl'']
	\|(Right, Number) Returns the number of unique tags assigned to the thing that match the tag template ''tmpl''. If a tag is assigned multiple times, it is only counted once. The template must use the standard "group.id" syntax and may contain a wildcard.<br>		\|(Right, Number) Returns the number of unique tags assigned to the pick/thing associated with the template that match the tag template ''tmpl''. If a tag is assigned multiple times, it is only counted once. The tag template must use the standard "group.id" syntax and may contain a wildcard.<br>
	Example: result = this.tagunique[skill.?]		Example: result = this.tagunique[skill.?]
	\|-		\|-
	\|tagexpr[''expr'']		\|tagexpr[''expr'']
	\|(Right, Number) Returns non-zero if the tags assigned to the thing match the tag expression ''expr'', else zero is returned. The ''expr'' parameter must be a valid tag expression.<br>		\|(Right, Number) Returns non-zero if the tags assigned to the pick/thing associated with the template match the tag expression ''expr'', else zero is returned. The ''expr'' parameter must be a valid tag expression.<br>
	Example: result = this.tagexpr[class.wizard & (val:spelllevel.wizard? > 5)]		Example: result = this.tagexpr[class.wizard & (val:spelllevel.wizard? > 5)]
	\|-		\|-
Line 100:		Line 98:
	\|-		\|-
	\|isidentity[''grp'']		\|isidentity[''grp'']
	\|(Right, Number) ~~As the counterpart of "setidentity", this target reference returns~~ non-zero if the indicated identity tag has been assigned to the pick ~~and zero if not~~. 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>		\|(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]		Example: result = this.isidentity[groupid]
	\|-		\|-
Line 139:		Line 137:
	\|-		\|-
	\|autoplace[''gap'']		\|autoplace[''gap'']
	\|(Right, Number) Automatically places the ~~layout~~ within the containing ~~visual element~~, subject to the standard rules for [[Using Automatic Placement\|automatic placement]]. The ''gap'' parameter specifies the gap to be used between this ~~layout~~ and the previous placed element. The parameter can be omitted, in which case the established "autogap" is utilized.<br>		\|(Right, Number) Automatically places the template within the containing layout, subject to the standard rules for [[Using Automatic Placement\|automatic placement]]. 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. Automatic placement for templates can only be used within layouts. A value of zero is always returned.<br>
	Example: this.autoplace[42]<br>		Example: perform this.autoplace[42]<br>
	Example: this.autoplace		Example: perform this.autoplace
	\|-		\|-
	\|}		\|}

Rob at 07:42, 7 December 2008

2008-12-07T07:42:05Z

← Older revision		Revision as of 07:42, 7 December 2008
Line 15:		Line 15:
	\|-		\|-
	\|left		\|left
	\|(Left, Right, Number) Accesses the position of the left edge of the ~~layout~~ within the containing visual element.<br>		\|(Left, Right, Number) Accesses the position of the left edge of the template within the containing visual element.<br>
	Example: result = this.left<br>		Example: result = this.left<br>
	Example: this.left = 42		Example: this.left = 42
	\|-		\|-
	\|top		\|top
	\|(Left, Right, Number) Accesses the position of the top edge of the ~~layout~~ within the containing visual element.<br>		\|(Left, Right, Number) Accesses the position of the top edge of the template within the containing visual element.<br>
	Example: result = this.top<br>		Example: result = this.top<br>
	Example: this.top = 42		Example: this.top = 42
	\|-		\|-
	\|right		\|right
	\|(Right, Number) Returns the position of the right edge of the ~~layout~~ within the containing visual element.<br>		\|(Right, Number) Returns the position of the right edge of the template within the containing visual element.<br>
	Example: result = this.right		Example: result = this.right
	\|-		\|-
	\|bottom		\|bottom
	\|(Right, Number) Returns the position of the bottom edge of the ~~layout~~ within the containing visual element.<br>		\|(Right, Number) Returns the position of the bottom edge of the template within the containing visual element.<br>
	Example: result = this.bottom		Example: result = this.bottom
	\|-		\|-
	\|visible		\|visible
	\|(Left, Right, Number) Controls the visibility of the ~~layout~~ within the containing visual element. A non-zero value indicates the ~~layout~~ is visible and a zero value indicates hidden.<br>		\|(Left, Right, Number) Controls the visibility of the template within the containing visual element. A non-zero value indicates the template is visible and a zero value indicates hidden. The visibility of templates cannot be controlled within tables.<br>
	Example: result = this.visible<br>		Example: result = this.visible<br>
	Example: this.visible = 1		Example: this.visible = 1
Line 39:		Line 39:
	{ "issizing", READONLY, 0, false },		{ "issizing", READONLY, 0, false },
	{ "inheader", READONLY, 0, false }		{ "inheader", READONLY, 0, false }
			\|scrollbar
			\|(Right, Number) Returns non-zero if the "sizing" logic of a template within a table is being performed. This allows detection of the sizing logic so that all non-sizing behaviors can be skipped for the template.<br>
			Example: result = this.issizing
			\|-
			\|inheader
			\|(Right, Number) Returns non-zero if the template is being positioned for use as a header within a table. This makes it possible to distinguish the context for a template that is being used as a dual-purpose header.<br>
			Example: result = this.inheader
			\|-
	\|scrollbar		\|scrollbar
	\|(Right, Number) Returns the width of a scroller, in pixels.<br>		\|(Right, Number) Returns the width of a scroller, in pixels.<br>

Rob: New page: {{context|Kit Reference|Target References}} The "template" script context governs the operations that can be applied to templates within layouts and tables. The complete list of target re...

2008-12-07T07:36:55Z

New page: {{context|Kit Reference|Target References}} The "template" script context governs the operations that can be applied to templates within layouts and tables. The complete list of target re...

New page

{{context|Kit Reference|Target References}}

The "template" script context governs the operations that can be applied to templates within layouts and tables. The complete list of target references for templates is presented in the table below.

:{| class="infotable"
|class="leftnormal"|width
|(Left, Right, Number) Accesses the width of the template. Unless explicitly specified within the XML, the width of a template is automatically initialized. If the template is within a table, the width is set the interior width of the containing table, minus any assigned margins. Otherwise, the template is initialized to a width of 100. 
Example: result = this.width 
Example: this.width = 420
|-
|height
|(Left, Right, Number) Accesses the height of the template. Unless explicitly specified within the XML, the height of a layout is automatically initialized to zero and must be set by the author via a suitable script. 
Example: result = this.height 
Example: this.height = 420
|-
|left
|(Left, Right, Number) Accesses the position of the left edge of the layout within the containing visual element. 
Example: result = this.left 
Example: this.left = 42
|-
|top
|(Left, Right, Number) Accesses the position of the top edge of the layout within the containing visual element. 
Example: result = this.top 
Example: this.top = 42
|-
|right
|(Right, Number) Returns the position of the right edge of the layout within the containing visual element. 
Example: result = this.right
|-
|bottom
|(Right, Number) Returns the position of the bottom edge of the layout within the containing visual element. 
Example: result = this.bottom
|-
|visible
|(Left, Right, Number) Controls the visibility of the layout within the containing visual element. A non-zero value indicates the layout is visible and a zero value indicates hidden. 
Example: result = this.visible 
Example: this.visible = 1
|-
{ "issizing", READONLY, 0, false },
{ "inheader", READONLY, 0, false }
|scrollbar
|(Right, Number) Returns the width of a scroller, in pixels. 
Example: result = this.scrollbar
|-
|tagis[''tmpl'']
|(Right, Number) Returns non-zero if any tags assigned to the pick match the tag template ''tmpl'', else zero if no tags match. The template must use the standard "group.id" syntax and may contain a wildcard. 
Example: this.tagis[skill.?]
|-
|tagcount[''tmpl'']
|(Right, Number) Returns the number of tags assigned to the thing that match the tag template ''tmpl''. The template must use the standard "group.id" syntax and may contain a wildcard. 
Example: result = this.tagcount[skill.?]
|-
|tagvalue[''tmpl'']
|(Right, Number) Returns the value of a tag assigned to the thing that matches the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The template must use the standard "group.id" syntax and may contain a wildcard. 
Example: result = this.tagvalue[spelllevel.wizard?]
|-
|tagmin[''tmpl'']
|(Right, Number) Returns the minimum value of all tags assigned to the thing that match the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The template must use the standard "group.id" syntax and may contain a wildcard. 
Example: result = this.tagmin[spelllevel.wizard?]
|-
|tagmax[''tmpl'']
|(Right, Number) Returns the maximum value of all tags assigned to the thing that match the tag template ''tmpl''. The rules associated with tag values in tag expressions apply. The template must use the standard "group.id" syntax and may contain a wildcard. 
Example: result = this.tagmax[spelllevel.wizard?]
|-
|tagunique[''tmpl'']
|(Right, Number) Returns the number of unique tags assigned to the thing that match the tag template ''tmpl''. If a tag is assigned multiple times, it is only counted once. The template must use the standard "group.id" syntax and may contain a wildcard. 
Example: result = this.tagunique[skill.?]
|-
|tagexpr[''expr'']
|(Right, Number) Returns non-zero if the tags assigned to the thing match the tag expression ''expr'', else zero is returned. The ''expr'' parameter must be a valid tag expression. 
Example: result = this.tagexpr[class.wizard & (val:spelllevel.wizard? > 5)]
|-
|tagcountstr[''str'']
|(Right, Number) This target reference is identical to "tagcount", except that the ''str'' parameter is a string expression that is evaluated within the script. This allows the tag template to be dynamically determined via the script instead of being hard-wired at compilation. 
Example: result = this.tagcountstr["skill.?"]
|-
|tagvaluestr[''str'']
|(Right, Number) This target reference is identical to "tagvalue", except that the ''str'' parameter is a string expression that is evaluated within the script. This allows the tag template to be dynamically determined via the script instead of being hard-wired at compilation. 
Example: result = this.tagvaluestr["spelllevel.wizard?"]
|-
|tagminstr[''str'']
|(Right, Number) This target reference is identical to "tagmin", except that the ''str'' parameter is a string expression that is evaluated within the script. This allows the tag template to be dynamically determined via the script instead of being hard-wired at compilation. 
Example: result = this.tagminstr["spelllevel.wizard?"]
|-
|tagmaxstr[''str'']
|(Right, Number) This target reference is identical to "tagmax", except that the ''str'' parameter is a string expression that is evaluated within the script. This allows the tag template to be dynamically determined via the script instead of being hard-wired at compilation. 
Example: result = this.tagmaxstr["spelllevel.wizard?"]
|-
|taguniquestr[''str'']
|(Right, Number) This target reference is identical to "tagunique", except that the ''str'' parameter is a string expression that is evaluated within the script. This allows the tag template to be dynamically determined via the script instead of being hard-wired at compilation. 
Example: result = this.taguniquestr["skill.?"]
|-
|isidentity[''grp'']
|(Right, Number) As the counterpart of "setidentity", this target reference returns non-zero if the indicated identity tag has been assigned to the pick and zero if not. 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]]. 
Example: result = this.isidentity[groupid]
|-
|autotop
|(Left, Right, Number) Accesses the position of the top edge of the auto-place region within the containing visual element. 
Example: result = this.autotop 
Example: this.autotop = 42
|-
|autobottom
|(Left, Right, Number) Accesses the position of the bottom edge of the auto-place region within the containing visual element. 
Example: result = this.autobottom 
Example: this.autobottom = 420
|-
|autoleft
|(Left, Right, Number) Accesses the position of the left edge of the auto-place region within the containing visual element. 
Example: result = this.autoleft 
Example: this.autoleft = 42
|-
|autoright
|(Left, Right, Number) Accesses the position of the right edge of the auto-place region within the containing visual element. 
Example: result = this.autoright 
Example: this.autoright = 420
|-
|autowidth
|(Left, Right, Number) Accesses the width of the auto-place region within the containing visual element. 
Example: result = this.autowidth 
Example: this.autowidth = 420
|-
|autoheight
|(Left, Right, Number) Accesses the height of the auto-place region within the containing visual element. 
Example: result = this.autoheight 
Example: this.autoheight = 420
|-
|autogap
|(Left, Right, Number) Accesses the default gap size used when automatically placing elements within the containing visual element. The "autogap" defaults to zero. 
Example: result = this.autogap 
Example: this.autogap = 42
|-
|autoplace[''gap'']
|(Right, Number) Automatically places the layout within the containing visual element, subject to the standard rules for [[Using Automatic Placement|automatic placement]]. The ''gap'' parameter specifies the gap to be used between this layout and the previous placed element. The parameter can be omitted, in which case the established "autogap" is utilized. 
Example: this.autoplace[42] 
Example: this.autoplace
|-
|}