Pick Target References - Revision history

Colen at 18:06, 5 September 2014

2014-09-05T18:06:19Z

← Older revision		Revision as of 18:06, 5 September 2014
Line 129:		Line 129:
	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.interset[MyGroup,AltGroup]		Example: result = this.interset[MyGroup,AltGroup]

Colen at 23:23, 1 March 2011

2011-03-01T23:23:23Z

← Older revision		Revision as of 23:23, 1 March 2011
Line 45:		Line 45:
	\|-		\|-
	\|displaced		\|displaced
	\|(Right, Number) Returns non-zero if the pick has been [[Shadowing & Displacement\|displaced]]and also exists within an alternate container.<br>		\|(Right, Number) Returns non-zero if the pick has been [[Shadowing & Displacement\|displaced]] and also exists within an alternate container.<br>
	Example: result = this.displaced		Example: result = this.displaced
	\|-		\|-

Colen at 23:23, 1 March 2011

2011-03-01T23:23:11Z

← Older revision		Revision as of 23:23, 1 March 2011
Line 41:		Line 41:
	\|-		\|-
	\|shadowed		\|shadowed
	\|(Right, Number) Returns non-zero if the pick has been shadowed and also exists within an alternate container.<br>		\|(Right, Number) Returns non-zero if the pick has been [[Shadowing & Displacement\|shadowed]] and also exists within an alternate container.<br>
	Example: result = this.shadowed		Example: result = this.shadowed
	\|-		\|-
	\|displaced		\|displaced
	\|(Right, Number) Returns non-zero if the pick has been displaced and also exists within an alternate container.<br>		\|(Right, Number) Returns non-zero if the pick has been [[Shadowing & Displacement\|displaced]]and also exists within an alternate container.<br>
	Example: result = this.displaced		Example: result = this.displaced
	\|-		\|-
Line 147:		Line 147:
	<ul class="sets">		<ul class="sets">
	<li>parent – Tags are copied to the standard parent container of the pick.</li>		<li>parent – Tags are copied to the standard parent container of the pick.</li>
	<li>shadow – Tags are copied to the shadow container of the pick, which is only applicable when the pick has been shadowed.</li>		<li>shadow – Tags are copied to the [[Shadowing & Displacement\|shadow container]] of the pick, which is only applicable when the pick has been shadowed.</li>
	<li>origin – Tags are copied to the origin container of the pick, which is only applicable when the pick has been displaced.</li>		<li>origin – Tags are copied to the origin container of the pick, which is only applicable when the pick has been [[Shadowing & Displacement\|displaced]].</li>
	</ul>		</ul>
	The ''target'' parameter may be omitted, in which case all tags matching the tag template are copied to the "parent" container. Both parameters may also be omitted, in which case all tags within the pick are copied to the "parent" container.<br>		The ''target'' parameter may be omitted, in which case all tags matching the tag template are copied to the "parent" container. Both parameters may also be omitted, in which case all tags within the pick are copied to the "parent" container.<br>

Rob at 13:15, 7 December 2008

2008-12-07T13:15:38Z

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

			See Also: [[Pick Context Transitions]]

	Picks are going to be the most prevalent object type within any set of data files, so it's no surprise that picks have the largest and most varied assortment of target references. The complete list of target references for picks is presented in the table below.		Picks are going to be the most prevalent object type within any set of data files, so it's no surprise that picks have the largest and most varied assortment of target references. The complete list of target references for picks is presented in the table below.

Rob at 14:03, 6 December 2008

2008-12-06T14:03:27Z

← Older revision		Revision as of 14:03, 6 December 2008
Line 233:		Line 233:
	\|(Right, Number) Returns non-zero if the current pick directly bootstraps a pick with the specified id ''thing''.<br>		\|(Right, Number) Returns non-zero if the current pick directly bootstraps a pick with the specified id ''thing''.<br>
	Example: result = this.isbootstrap[thingid]		Example: result = this.isbootstrap[thingid]
			\|-
			\|rootnames[''spl'']
			\|(Right, String) Generates and returns a list of picks that bootstrap the current pick. The generated string appends the names of the root picks together, inserting the splicing string ''spl'' between each name if there is more than one. A pick with no root picks will return the empty string.<br>
			Example: result = this.rootnames["+"]
	\|-		\|-
	\|islinkage[''link'']		\|islinkage[''link'']
Line 258:		Line 262:
	Example: result = this.panelactive		Example: result = this.panelactive
	\|-		\|-
	\|~~sourcenames~~[		\|sourcerefs[''spl'']
	\|(Right, String)		\|(Right, String) Generates and returns a list of all sources that the current pick is dependent upon. The generated string appends the names of the sources together, inserting the splicing string ''spl'' between each name if there is more than one. A pick with no source dependencies will return the empty string.<br>
	\|-		Example: result = this.sourcerefs["+"]
	\|sourcerefs[
	~~\|(Right, String)~~
	\|-		\|-
	\|dynareg[		\|dynareg[''index'']
	\|(Right, Number)		\|(Right, Number) Registers a dynamic linkage to the current pick context and assigns that linkage the unique index value ''index''. Once registered, the current pick can be accessed from the "hero" context via the "dynalink" context transition. This makes it possible to dynamically setup access to a special pick throughout an actor. This target reference can only be utilized from within a [[Creation Script]]. Always returns a value of zero.<br>
			Example: perform this.dynareg[42]
	\|-		\|-
	\|isminion		\|isminion

Rob at 13:49, 6 December 2008

2008-12-06T13:49:47Z

← Older revision		Revision as of 13:49, 6 December 2008
Line 243:		Line 243:
	\|-		\|-
	\|creation		\|creation
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the pick was added to the character during "creation" mode and zero if added during "advancement" mode. This makes it possible to validate options that are only seelctable during character creation. If advancement mode is not enabled for the game system, all picks are always added in creation mode.<br>
			Example: result = this.creation
	\|-		\|-
	\|setfocus		\|setfocus
	\|(Right, Number)		\|(Right, Number) Establishes the current pick context as the new "pick focus". Thereafter, the script can use the "focus." initial context transition to directly access the pick that is setup as the focus. Always returns a value of zero.<br>
			Example: perform this.setfocus
	\|-		\|-
	\|ispanel		\|ispanel
	\|(Right, Number)		\|(Right, Number) Returns non-zero is the pick has a panel linkage defined for it. This allows generic handling of panel linkages within component scripts when the actual panel linkage is optionally controlled by the thing.<br>
			Example: result = this.ispanel
	\|-		\|-
	\|panelactive		\|panelactive
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the current active tab panel is the one specified as a panel linkage for the current pick. If the pick has no designated panel linkage, zero is returned.<br>
			Example: result = this.panelactive
	\|-		\|-
	\|sourcenames[		\|sourcenames[

Rob at 13:43, 6 December 2008

2008-12-06T13:43:22Z

← Older revision		Revision as of 13:43, 6 December 2008
Line 199:		Line 199:
	\|-		\|-
	\|isgear		\|isgear
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the pick is a piece of gear.<br>
			Example: result = this.isgear
			\|-
			\|isholdable
			\|(Right, Number) Returns non-zero if the pick is gear that can be placed into a gear holder.<br>
			Example: result = this.isholdable
	\|-		\|-
	\|isgearheld		\|isgearheld
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the pick is a piece of gear that is currently being held within another piece of gear.<br>
			Example: result = this.isgearheld
	\|-		\|-
	\|gearcount		\|gearcount
	\|(Right, Number)		\|(Right, Number) Returns the total number of pieces of gear that are currently being held within the pick. If the pick is not a gear holder, the count will always be zero.<br>
			Example: result = this.gearcount
	\|-		\|-
	\|gearpath[		\|gearpath[''spl'']
	\|(Right, String)		\|(Right, String) Generates and returns the entire gear containment hierarchy for this piece of gear. The hierarchy starts with the topmost gear holder of this pick and works downward through the immediate holder of the pick, showing the sequence. The generated string lists all the holders by name, inserting the splicing string ''spl'' between each name if there is more than one. A piece of gear that is not held will return the empty string.<br>
			Example: result = this.gearpath["+"]
	\|-		\|-
	\|isgearlist		\|isgearlist
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the pick is a gear holder and can contain a list of held gear, regardless of whether any gear is actually held.<br>
	\|-		Example: result = this.isgearlist
	~~\|gearlist[~~
	~~\|(Right, String)~~
	\|-		\|-
	\|~~isholdable~~		\|gearlist[''spl'',''expr'']
	\|(Right, ~~Number~~)		\|(Right, String) Generates and returns a list of gear held within the pick, provided the pick is a gear holder. Only picks that are designated as gear and that are assigned to this pick as their 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 pick that holds no gear matching the tag expression will return the empty string.<br>
			Example: result = this.gearlist["+",!Equipment.Natural]
	\|-		\|-
	\|stackable		\|stackable
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the pick can be stacked with other equivalent picks.<br>
			Example: result = this.stackable
	\|-		\|-
	\|isbootstrap[		\|isbootstrap[''thing'']
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the current pick directly bootstraps a pick with the specified id ''thing''.<br>
			Example: result = this.isbootstrap[thingid]
	\|-		\|-
	\|islinkage[		\|islinkage[''link'']
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the current pick possesses a linkage with the specified id ''link''.<br>
			Example: result = this.islinkage[linkid]
	\|-		\|-
	\|autonomous		\|autonomous

Rob at 12:42, 6 December 2008

2008-12-06T12:42:00Z

← Older revision		Revision as of 12:42, 6 December 2008
Line 166:		Line 166:
	\|-		\|-
	\|shareidentity[''grp'',''pick'']		\|shareidentity[''grp'',''pick'']
	\|(Right, Number) The pick with unique id ''pick'' is assigned the identity tag from the tag group ''grp'' for the current pick context. This allows a script to explicitly identify a pick and assign an identity tag to it. If the specified pick does not exist, a run-time error is reported.<br>		\|(Right, Number) The pick with unique id ''pick'' is assigned the identity tag from the tag group ''grp'' for the current pick context. This allows a script to explicitly identify a pick and assign an identity tag to it. The identity tag id is dictated by the initial context of the script. For more details, [[Identity Target References\|please check here]]. If the specified pick does not exist, a run-time error is reported. A value of zero is always returned.<br>
	Example: ~~result =~~ this.shareidentity[ClassSkill,mypick]		Example: perform this.shareidentity[ClassSkill,mypick]
	\|-		\|-
	\|pullidentity[''grp'']		\|pullidentity[''grp'']
	\|(Right, Number) Locates the identity tag from the tag group ''grp'' for the current pick context and assigns it to the initial script context. If the initial script context is neither a pick nor a container, a run-time error is reported.<br>		\|(Right, Number) Locates the identity tag from the tag group ''grp'' for the current pick context and assigns it to the initial script context. The identity tag id is dictated by the initial context of the script. For more details, [[Identity Target References\|please check here]]. If the initial script context is neither a pick nor a container, a run-time error is reported. A value of zero is always returned.<br>
	Example: ~~result =~~ this.pullidentity[groupid]		Example: perform this.pullidentity[groupid]
	\|-		\|-
	\|tagnames[''tmpl'',''spl'']		\|tagnames[''tmpl'',''spl'']
Line 186:		Line 186:
	\|-		\|-
	\|prereqok		\|prereqok
	\|(Right, Number)		\|(Right, Number) Returns non-zero if the pick satisfies all of its pre-requisites. May not be used during evaluation.<br>
			Example: result = this.prereqok
	\|-		\|-
	\|prereqnum		\|prereqnum
	\|(Right, Number)		\|(Right, Number) Returns the total number of pre-requisite rules that exist for the current pick. May not be used during evaluation.<br>
			Example: result = this.prereqnum
	\|-		\|-
	\|prereqmsg[		\|prereqmsg[''index'']
	\|(Right, String)		\|(Right, String) Returns the message associated with a specific pre-requisite test for the current pick, where the desired test is given by ''index''. The index is zero-based, so the values 0 through 4 should be used for a pick with 5 pre-requisites. If the individual pre-requisite is satisfied, the text returned is the empty string. Otherwise, the text returned is the corresponding message. May not be used during evaluation.<br>
			Example: result = this.prereqmsg[i]<br>
			{{note}}Retrieving the message for individual pre-requisite tests will trigger a re-calculation '''every''' time, so it is expensive and should only be used sparingly.
	\|-		\|-
	\|isgear		\|isgear

Rob at 12:29, 6 December 2008

2008-12-06T12:29:17Z

← Older revision		Revision as of 12:29, 6 December 2008
Line 165:		Line 165:
	Example: result = this.countidentity[groupid]		Example: result = this.countidentity[groupid]
	\|-		\|-
	\|shareidentity[		\|shareidentity[''grp'',''pick'']
	\|(Right, Number)		\|(Right, Number) The pick with unique id ''pick'' is assigned the identity tag from the tag group ''grp'' for the current pick context. This allows a script to explicitly identify a pick and assign an identity tag to it. If the specified pick does not exist, a run-time error is reported.<br>
			Example: result = this.shareidentity[ClassSkill,mypick]
	\|-		\|-
	\|pullidentity[		\|pullidentity[''grp'']
	\|(Right, Number)		\|(Right, Number) Locates the identity tag from the tag group ''grp'' for the current pick context and assigns it to the initial script context. If the initial script context is neither a pick nor a container, a run-time error is reported.<br>
			Example: result = this.pullidentity[groupid]
	\|-		\|-
	\|tagnames[''tmpl'',''spl'']		\|tagnames[''tmpl'',''spl'']

Rob at 12:16, 6 December 2008

2008-12-06T12:16:56Z

← Older revision		Revision as of 12:16, 6 December 2008
Line 131:		Line 131:
	Example: result = this.interset[MyGroup,AltGroup]		Example: result = this.interset[MyGroup,AltGroup]
	\|-		\|-
	\|pulltags[		\|pulltags[''tmpl'',''grp'']
	\|(Right, Number)		\|(Right, Number) Copies tags from the transitioned pick context into the initial pick context and returns the total number of tags copied. The set of tags to be copied from the transitioned pick context are dictated by the tag template ''tmpl''. If the second parameter is omitted, the identified tags are copied to the initial pick context. If the second parameter is provided, ''grp'' must specify a tag group. All tags identified by ''tmpl'' are mapped to equivalent tags within the tag group ''grp'', and those mapped tags are then assigned to the initial pick context. When mapping, an equivalent mapped tag must exist for all identified tags. Both the initial and transitioned script context must be picks.<br>
			Example: result = this.pulltags[thingid.?]<br>
			Example: result = this.pulltags[thingid.?,Ability]
	\|-		\|-
	\|pushtags[		\|pushtags[''tmpl'',''grp'']
	\|(Right, Number)		\|(Right, Number) Copies tags from the initial pick context into the transitioned pick context and returns the total number of tags copied. This target reference is identical in behavior to "pulltags", except that the tags are copied in the opposite direction.<br>
			Example: result = this.pushtags[thingid.?]<br>
			Example: result = this.pushtags[thingid.?,Ability]
	\|-		\|-
	\|forward		\|forward[''tmpl'',''target'']
	\|(Right, Number)		\|(Right, Number) Copies tags from the pick context into the corresponding container and returns the total number of tags copied. The set of tags to be copied are dictated by the tag template ''tmpl''. The tags are copied to the container dictated by ''target'', which must be one of the following values:
			<ul class="sets">
			<li>parent – Tags are copied to the standard parent container of the pick.</li>
			<li>shadow – Tags are copied to the shadow container of the pick, which is only applicable when the pick has been shadowed.</li>
			<li>origin – Tags are copied to the origin container of the pick, which is only applicable when the pick has been displaced.</li>
			</ul>
			The ''target'' parameter may be omitted, in which case all tags matching the tag template are copied to the "parent" container. Both parameters may also be omitted, in which case all tags within the pick are copied to the "parent" container.<br>
			Example: result = this.forward[thingid.?,shadow]<br>
			Example: result = this.forward[thingid.?]<br>
			Example: result = this.forward
	\|-		\|-
	\|setidentity[''grp'']		\|setidentity[''grp'']