Container Target References - Revision history

Colen at 18:06, 5 September 2014

2014-09-05T18:06:01Z

← Older revision		Revision as of 18:06, 5 September 2014
Line 105:		Line 105:
	Example: result = hero.tagmatch[NeedStatus,HasStatus,initial]		Example: result = hero.tagmatch[NeedStatus,HasStatus,initial]
	\|-		\|-
	\|intersect[''~~init~~'',''~~curr~~'']		\|intersect[''curr'',''init'']
	\|(Right, Number) Returns non-zero if tags within the initial script context also exist within the currently transitioned context, else zero. All of the tags that belong to the ''init'' tag group within the initial script context are compared against the tags that belong to the ''curr'' tag group within the current context. If any of those tags possess the identical tag id, then a match is returned (i.e. non-zero). The same tag group may be used for both contexts, and both contexts must be objects that possess tags (i.e. container, pick, or thing).<br>		\|(Right, Number) Returns non-zero if tags within the initial script context also exist within the currently transitioned context, else zero. All of the tags that belong to the ''init'' tag group within the initial script context are compared against the tags that belong to the ''curr'' tag group within the current context. If any of those tags possess the identical tag id, then a match is returned (i.e. non-zero). The same tag group may be used for both contexts, and both contexts must be objects that possess tags (i.e. container, pick, or thing).<br>
	Example: result = this.intersect[MyGroup,AltGroup]		Example: result = this.intersect[MyGroup,AltGroup]

Colen at 17:36, 5 September 2014

2014-09-05T17:36:39Z

← Older revision		Revision as of 17:36, 5 September 2014
Line 107:		Line 107:
	\|intersect[''init'',''curr'']		\|intersect[''init'',''curr'']
	\|(Right, Number) Returns non-zero if tags within the initial script context also exist within the currently transitioned context, else zero. All of the tags that belong to the ''init'' tag group within the initial script context are compared against the tags that belong to the ''curr'' tag group within the current context. If any of those tags possess the identical tag id, then a match is returned (i.e. non-zero). The same tag group may be used for both contexts, and both contexts must be objects that possess tags (i.e. container, pick, or thing).<br>		\|(Right, Number) Returns non-zero if tags within the initial script context also exist within the currently transitioned context, else zero. All of the tags that belong to the ''init'' tag group within the initial script context are compared against the tags that belong to the ''curr'' tag group within the current context. If any of those tags possess the identical tag id, then a match is returned (i.e. non-zero). The same tag group may be used for both contexts, and both contexts must be objects that possess tags (i.e. container, pick, or thing).<br>
	Example: result = this.~~interset~~[MyGroup,AltGroup]		Example: result = this.intersect[MyGroup,AltGroup]
	\|-		\|-
	\|inherit[''id'']		\|inherit[''id'']

Rob at 13:14, 7 December 2008

2008-12-07T13:14:54Z

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

			See Also: [[Container Context Transitions]]

	There are a wide assortment of operations that can be performed on containers, some of which modify the container and some that simply retrieve information about the container. The container context applies equally to heroes and gizmos, although there are some behavioral differences that arise for some target references. The complete list of target references for containers is presented in the table below.		There are a wide assortment of operations that can be performed on containers, some of which modify the container and some that simply retrieve information about the container. The container context applies equally to heroes and gizmos, although there are some behavioral differences that arise for some target references. The complete list of target references for containers is presented in the table below.

Rob at 13:37, 6 December 2008

2008-12-06T13:37:41Z

← Older revision		Revision as of 13:37, 6 December 2008
Line 183:		Line 183:
	\|gearlist[''spl'',''expr'']		\|gearlist[''spl'',''expr'']
	\|(Right, String) Generates and returns a list of gear held within the container, which means gear that is '''not''' held within another gear holder. Only picks that are designated as gear and that are not assigned to a holder are candidates for inclusion in the list. Each candidate piece of gear is compared against the tag expression ''expr'', and only those that satisfy the tag expression are included in the final list. The generated string appends the names of all pieces of gear together, inserting the splicing string ''spl'' between each name if there is more than one. A container that holds no gear matching the tag expression will return the empty string.<br>		\|(Right, String) Generates and returns a list of gear held within the container, which means gear that is '''not''' held within another gear holder. Only picks that are designated as gear and that are not assigned to a holder are candidates for inclusion in the list. Each candidate piece of gear is compared against the tag expression ''expr'', and only those that satisfy the tag expression are included in the final list. The generated string appends the names of all pieces of gear together, inserting the splicing string ''spl'' between each name if there is more than one. A container that holds no gear matching the tag expression will return the empty string.<br>
	Example: this.gearlist["+",!Equipment.Natural]		Example: result = this.gearlist["+",!Equipment.Natural]
	\|-		\|-
	\|geartree[''expr'']		\|geartree[''expr'']

Rob at 13:34, 6 December 2008

2008-12-06T13:34:43Z

← Older revision		Revision as of 13:34, 6 December 2008
Line 182:		Line 182:
	\|-		\|-
	\|gearlist[''spl'',''expr'']		\|gearlist[''spl'',''expr'']
	\|(Right, String) Generates and returns a list of gear held within the container. Only picks that are designated as gear and that are not assigned to a holder are candidates for inclusion in the list. Each candidate piece of gear is compared against the tag expression ''expr'', and only those that satisfy the tag expression are included in the final list. The generated string appends the names of all pieces of gear together, inserting the splicing string ''spl'' between each name if there is more than one. A container that holds no gear matching the tag expression will return the empty string.<br>		\|(Right, String) Generates and returns a list of gear held within the container, which means gear that is '''not''' held within another gear holder. Only picks that are designated as gear and that are not assigned to a holder are candidates for inclusion in the list. Each candidate piece of gear is compared against the tag expression ''expr'', and only those that satisfy the tag expression are included in the final list. The generated string appends the names of all pieces of gear together, inserting the splicing string ''spl'' between each name if there is more than one. A container that holds no gear matching the tag expression will return the empty string.<br>
	Example: this.gearlist["+",!Equipment.Natural]		Example: this.gearlist["+",!Equipment.Natural]
	\|-		\|-

Rob at 06:10, 6 December 2008

2008-12-06T06:10:57Z

← Older revision		Revision as of 06:10, 6 December 2008
Line 1:		Line 1:
	{{context\|Kit Reference\|Target References}}		{{context\|Kit Reference\|Target References}}

	There are a wide assortment of operations that can be performed on containers, some of which modify the container and some that simply retrieve information about the container. The complete list of ~~these operations~~ is presented in the table below.		There are a wide assortment of operations that can be performed on containers, some of which modify the container and some that simply retrieve information about the container. The container context applies equally to heroes and gizmos, although there are some behavioral differences that arise for some target references. The complete list of target references for containers is presented in the table below.

	{{note}}When a container is accessed from within a visual script, all operations are restricted to read-only behavior. Any attempts to modify a container from within a visual script will fail.		{{note}}When a container is accessed from within a visual script, all operations are restricted to read-only behavior. Any attempts to modify a container from within a visual script will fail.

Rob at 06:09, 6 December 2008

2008-12-06T06:09:01Z

@@ Line 29: / Line 29: @@
 |(Right, String) Returns the name of the player that is associated with the current lead. The name is whatever has been entered by the user.<br>
 Example: result = this.playername
 |-
 |assign[''tag'']
@@ Line 145: / Line 141: @@
 |-
 |isminion
-|(Right, Number) Returns non-zero if the container is a minion, else zero.<br>
+|(Right, Number) Returns non-zero if the container is or resides within a minion, else zero.<br>
 Example: result = this.isminion
 |-
 |ismaster
-|(Right, Number) Returns non-zero if the container is a master, else zero.<br>
+|(Right, Number) Returns non-zero if the container is or resides within a master, else zero.<br>
 Example: result = this.ismaster
 |-
 |hasminion[''id'']
-|(Right, Number) Returns non-zero if the container possesses a minion with the specified ''id''. If the container is not a master or does not contain the specified minion, zero is returned.<br>
+|(Right, Number) Returns non-zero if the container is or resides within an actor that possesses a minion with the specified ''id''. If the container is not within a master or does not contain the specified minion, zero is returned.<br>
 Example: result = this.hasminion[myminion]
 |-
@@ Line 192: / Line 188: @@
 |(Right, String) Generates and returns a hierarchical tree view of the gear picks possessed by the container context, as appropriate for use within the Dashboard and Tactical Console. Only picks that are designated as gear are candidates for inclusion in the report. Each candidate piece of gear is compared against the tag expression ''expr'', and only those that satisfy the tag expression are included in the final report. All gear is output in a hierarchy, where each level of containment is indented beneath the level above it. Gear within child gizmos is also included, with indentation as if the gizmo were a holder within the container and its contents indented beneath it.<br>
 Example: result = this.geartree[!Helper.NoMove]
 |-
 |}

Rob at 03:57, 6 December 2008

2008-12-06T03:57:21Z

Rob at 03:54, 6 December 2008

2008-12-06T03:54:14Z

← Older revision		Revision as of 03:54, 6 December 2008
Line 229:		Line 229:
	\|(Right, Number) Moves the actor upwards or downwards within the Tactical Console, thereby adjusting its initiative position. The number of slots to move is given by the numeric expression ''expr'', with a positive value moving the actor later in the initiative sequence and a negative value earlier. To move an actor down in the order (i.e. later in combat), use "+1", and use "-1" to move the actor upwards. To move an actor to the top or bottom of the initiative order, simply use a very large value, as the engine will safely bound all adjustments. Always returns a value of zero.<br>		\|(Right, Number) Moves the actor upwards or downwards within the Tactical Console, thereby adjusting its initiative position. The number of slots to move is given by the numeric expression ''expr'', with a positive value moving the actor later in the initiative sequence and a negative value earlier. To move an actor down in the order (i.e. later in combat), use "+1", and use "-1" to move the actor upwards. To move an actor to the top or bottom of the initiative order, simply use a very large value, as the engine will safely bound all adjustments. Always returns a value of zero.<br>
	Example: perform this.combatmove[-1]		Example: perform this.combatmove[-1]
	\|-
	~~\|combatmovenow~~
	\|
	\|-		\|-
	\|combatact		\|combatact
	\|		\|(Right, Number) Designates the actor as having acted this combat turn and triggers an update to determine the next "ready" actor(s). Always returns a value of zero.<br>
			Example: perform this.combatact
	\|-		\|-
	\|combatdefer		\|combatdefer
	\|		\|(Right, Number) Designates the actor as having deferred its action this combat turn and triggers an update to determine the next "ready" actor(s). Always returns a value of zero.<br>
			Example: perform this.combatdefer
			\|-
			\|combatmovenow
			\|(Right, Number) Moves the actor within the initiative sequence such that it is positioned immediately '''before''' the first actor that is currently designated as "ready". This is intended for use when a deferred actor finally acts, as its initiative position is moved to the current slot in the queue. Always returns a value of zero.<br>
			Example: perform this.combatmovenow
	\|-		\|-
	\|}		\|}

Rob at 03:51, 6 December 2008

2008-12-06T03:51:00Z

← Older revision		Revision as of 03:51, 6 December 2008
Line 210:		Line 210:
	\|-		\|-
	\|combatant		\|combatant
	\|		\|(Right, Left, Number) Indicates whether the actor is managed as a combatant or not within the Tactical Console, with a non-zero value indicating a combatant. If a new value is assigned, the combatant state of the actor is changed.<br>
			Example: result = this.combatant<br>
			Example: this.combatant = 0
	\|-		\|-
	\|initchange		\|initchange
	\|		\|(Right, Number) Returns non-zero if the actor's current initiative value has been modified by the user.<br>
			Example: result = this.initchange
	\|-		\|-
	\|ismoveup		\|ismoveup
	\|		\|(Right, Number) Returns non-zero if the actor can be moved upwards within the Tactical Console, thereby adjusting its initiative value.<br>
			Example: result = this.ismoveup
	\|-		\|-
	\|ismovedown		\|ismovedown
	\|		\|(Right, Number) Returns non-zero if the actor can be moved downwards within the Tactical Console, thereby adjusting its initiative value.<br>
			Example: result = this.ismovedown
	\|-		\|-
	\|combatmove[''expr'']		\|combatmove[''expr'']
	\|		\|(Right, Number) Moves the actor upwards or downwards within the Tactical Console, thereby adjusting its initiative position. The number of slots to move is given by the numeric expression ''expr'', with a positive value moving the actor later in the initiative sequence and a negative value earlier. To move an actor down in the order (i.e. later in combat), use "+1", and use "-1" to move the actor upwards. To move an actor to the top or bottom of the initiative order, simply use a very large value, as the engine will safely bound all adjustments. Always returns a value of zero.<br>
			Example: perform this.combatmove[-1]
	\|-		\|-
	\|combatmovenow		\|combatmovenow

← Older revision		Revision as of 03:57, 6 December 2008
Line 104:		Line 104:
	\|-		\|-
	\|tagmatch[''refgrp'',''match'',''ref'']		\|tagmatch[''refgrp'',''match'',''ref'']
	\|(Right, Number) Returns non-zero if any tags within a reference context also exist within a match context, else zero. This allows tags from one context to be verified to exist within another context, making tag-based comparisons between two objects possible. For details, ~~please see~~ [[The "tagmatch" Target Reference]].<br>		\|(Right, Number) Returns non-zero if any tags within a reference context also exist within a match context, else zero. This allows tags from one context to be verified to exist within another context, making tag-based comparisons between two objects possible. For more details, [[The "tagmatch" Target Reference\|please check here]].<br>
	Example: result = hero.tagmatch[NeedStatus,HasStatus,initial]		Example: result = hero.tagmatch[NeedStatus,HasStatus,initial]
	\|-		\|-
Line 133:		Line 133:
	\|-		\|-
	\|setidentity[''grp'']		\|setidentity[''grp'']
	\|(Right, Number) Assigns to the container the identity tag from the tag group ''grp'' that corresponds to the initial context of the script. The identity tag id is dictated by the initial context of the script.<br>		\|(Right, Number) Assigns to the container the identity tag from the tag group ''grp'' that corresponds to the initial context of the script. The identity tag id is dictated by the initial context of the script. For more details, [[Identity Target References\|please check here]].<br>
	Example: result = this.setidentity[groupid]		Example: result = this.setidentity[groupid]
	\|-		\|-
	\|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 container 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.<br>		\|(Right, Number) As the counterpart of "setidentity", this target reference returns non-zero if the indicated identity tag has been assigned to the container 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>
	Example: result = this.isidentity[groupid]		Example: result = this.isidentity[groupid]
	\|-		\|-
	\|countidentity[''grp'']		\|countidentity[''grp'']
	\|(Right, Number) Similar to "isidentity", this target reference returns the count of the identity tags assigned to the container. The identity tag sought must be from the tag group ''grp'' and the tag id is dictated by the initial context of the script.<br>		\|(Right, Number) Similar to "isidentity", this target reference returns the count of the identity tags assigned to the container. 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.countidentity[groupid]		Example: result = this.countidentity[groupid]
	\|-		\|-