Pick Context - Revision history

Colen at 18:07, 5 September 2014

2014-09-05T18:07:03Z

← Older revision		Revision as of 18:07, 5 September 2014
Line 215:		Line 215:
	Example: result = hero.heromatch[NeedStatus,HasStatus,initial]		Example: result = hero.heromatch[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: /* Context Transitions{{anchor|transitions}} */

2011-07-25T16:20:42Z

Context Transitions{{anchor|transitions}}

← Older revision		Revision as of 16:20, 25 July 2011
Line 23:		Line 23:
	\|-		\|-
	\|parent		\|parent
	\|Transitions to the [[Pick Context\|pick context]] corresponding to the parent pick that attaches the container of this pick. If the container is a hero and has no parent pick, the transition fails to resolve.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the parent pick that attaches the container of this pick. If the container is a hero and has no parent pick, the transition fails to resolve. (This it effectively a shorthand for "container.parent".)<br>
	Example: this.parent		Example: this.parent
	\|-		\|-

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

2011-07-25T16:19:38Z

Context Transitions{{anchor|transitions}}

← Older revision		Revision as of 16:19, 25 July 2011
Line 23:		Line 23:
	\|-		\|-
	\|parent		\|parent
	\|Transitions to the [[~~Container~~ Context\|~~container~~ context]] corresponding to the ~~immediate~~ container of the ~~current~~ pick, ~~just like~~ the ~~"container"~~ transition.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the parent pick that attaches the container of this pick. If the container is a hero and has no parent pick, the transition fails to resolve.<br>
	Example: this.parent		Example: this.parent
	\|-		\|-

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

2011-03-01T23:24:05Z

Context Transitions{{anchor|transitions}}

← Older revision		Revision as of 23:24, 1 March 2011
Line 69:		Line 69:
	\|-		\|-
	\|shadow		\|shadow
	\|Transitions to the [[Container Context\|container context]] corresponding to the container into which the current pick is shadowed. If the pick is not shadowed, an error is reported and the transition fails to resolve.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the container into which the current pick is [[Shadowing & Displacement\|shadowed]]. If the pick is not shadowed, an error is reported and the transition fails to resolve.<br>
	Example: this.shadow		Example: this.shadow
	\|-		\|-

Rob at 09:45, 12 May 2009

2009-05-12T09:45:06Z

← Older revision		Revision as of 09:45, 12 May 2009
Line 210:		Line 210:
	\|(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>		\|(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]
			\|-
			\|heromatch[''refgrp'',''match'',''ref'']
			\|(Right, Number) Returns non-zero if any tags within the actor also exist within a match context, else zero. This allows tags from the actor to be verified to exist within another context, making tag-based comparisons between the actor and another object possible. The key difference between "heromatch" and "tagmatch" is that this target reference always assumes the initial context is the actor, which is then compared against the context that is transitioned to. For more details, [[The "tagmatch" Target Reference\|please check here]].<br>
			Example: result = hero.heromatch[NeedStatus,HasStatus,initial]
	\|-		\|-
	\|intersect[''init'',''curr'']		\|intersect[''init'',''curr'']

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

2009-02-20T09:54:32Z

Target References{{anchor|references}}

← Older revision		Revision as of 09:54, 20 February 2009
Line 349:		Line 349:
	\|(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>		\|(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["+"]		Example: result = this.sourcerefs["+"]
			\|-
			\|uniqindex
			\|(Right, Number) Returns an integer value that uniquely identifies the pick throughout the entire portfolio. This value is not guaranteed to be the same when the portfolio is reloaded. It is intended for use in differentiating picks within rules and should never be saved in any way or otherwise used as a persistent reference.<br>
			Example: result = this.uniqindex
	\|-		\|-
	\|dynareg[''index'']		\|dynareg[''index'']

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

2009-02-20T02:47:41Z

Target References{{anchor|references}}

← Older revision		Revision as of 02:47, 20 February 2009
Line 216:		Line 216:
	\|-		\|-
	\|pulltags[''tmpl'',''grp'']		\|pulltags[''tmpl'',''grp'']
	\|(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>		\|(Right, Number) Copies tags from the transitioned pick context into the initial pick or container context and returns the total number of tags copied. The set of tags to be copied from the transitioned context are dictated by the tag template ''tmpl''. If the second parameter is omitted, the identified tags are copied to the initial 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 context. When mapping, an equivalent mapped tag must exist for all identified tags. Both the initial and transitioned script context must be either picks or containers.<br>
	Example: result = this.pulltags[thingid.?]<br>		Example: result = this.pulltags[thingid.?]<br>
	Example: result = this.pulltags[thingid.?,Ability]		Example: result = this.pulltags[thingid.?,Ability]
	\|-		\|-
	\|pushtags[''tmpl'',''grp'']		\|pushtags[''tmpl'',''grp'']
	\|(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>		\|(Right, Number) Copies tags from the initial pick or container 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.?]<br>
	Example: result = this.pushtags[thingid.?,Ability]		Example: result = this.pushtags[thingid.?,Ability]

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

2009-02-20T02:13:56Z

Target References{{anchor|references}}

← Older revision		Revision as of 02:13, 20 February 2009
Line 364:		Line 364:
	\|hasminion[''id'']		\|hasminion[''id'']
	\|(Right, Number) Returns non-zero if the pick resides within an actor that possesses a minion with the specified ''id''. The parameter can be omitted, in which case non-zero is returned only if the pick directly attaches a minion. If the pick is not within a master or the specified minion does not exist, zero is returned.<br>		\|(Right, Number) Returns non-zero if the pick resides within an actor that possesses a minion with the specified ''id''. The parameter can be omitted, in which case non-zero is returned only if the pick directly attaches a minion. If the pick is not within a master or the specified minion does not exist, zero is returned.<br>
	Example: result = this.hasminion[myminion]		Example: result = this.hasminion[myminion]<br>
	Example: result = this.hasminion		Example: result = this.hasminion
	\|-		\|-
	\|}		\|}

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

2009-02-20T00:41:07Z

Target References{{anchor|references}}

← Older revision		Revision as of 00:41, 20 February 2009
Line 112:		Line 112:
	\|(Right, Number) Returns non-zero if the pick directly attaches a child gizmo.<br>		\|(Right, Number) Returns non-zero if the pick directly attaches a child gizmo.<br>
	Example: result = this.isgizmo		Example: result = this.isgizmo
			\|-
			\|isentity
			\|(Right, Number) Returns non-zero if the pick directly attaches a child entity.<br>
			Example: result = this.isentity<br>
			{{note}}This target reference is essentially identical to "isgizmo" (above).
	\|-		\|-
	\|isunique		\|isunique

Rob at 23:26, 7 December 2008

2008-12-07T23:26:37Z

← Older revision		Revision as of 23:26, 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
	\|-		\|-
	\|hero		\|hero
	\|Transitions to the [[Hero Context~~#transitions~~\|hero context]] corresponding to the hero that contains the current pick.<br>		\|Transitions to the [[Hero Context\|hero context]] corresponding to the hero that contains the current pick.<br>
	Example: this.hero		Example: this.hero
	\|-		\|-
	\|container		\|container
	\|Transitions to the [[Container Context~~#transitions~~\|container context]] corresponding to the immediate container of the current pick, whether it be a hero or a gizmo.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the immediate container of the current pick, whether it be a hero or a gizmo.<br>
	Example: this.container		Example: this.container
	\|-		\|-
	\|parent		\|parent
	\|Transitions to the [[Container Context~~#transitions~~\|container context]] corresponding to the immediate container of the current pick, just like the "container" transition.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the immediate container of the current pick, just like the "container" transition.<br>
	Example: this.parent		Example: this.parent
	\|-		\|-
	\|gizmo		\|gizmo
	\|Transitions to the [[Container Context~~#transitions~~\|container context]] corresponding to the child gizmo directly attached by the pick. If the pick has no attached child gizmo, the transition fails to resolve.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the child gizmo directly attached by the pick. If the pick has no attached child gizmo, the transition fails to resolve.<br>
	Example: this.gizmo		Example: this.gizmo
	\|-		\|-
	\|field[''id'']		\|field[''id'']
	\|Transitions to the [[Field Context~~#transitions~~\|field context]] corresponding to the field within the current pick that has the ''id'' specified. If the given field does not exist for the current pick, the transition fails to resolve.<br>		\|Transitions to the [[Field Context\|field context]] corresponding to the field within the current pick that has the ''id'' specified. If the given field does not exist for the current pick, the transition fails to resolve.<br>
	Example: this.field[myfield]<br>		Example: this.field[myfield]<br>
	{{note}}Within things and picks, there are a number of pre-defined pseudo-fields that are always defined and that allow access to facets of the pick that are not governed by user-defined fields. These pseudo-fields behave like normal fields in all respects within scripts, except that some are read-only. The list of pre-defined fields can be found elsewhere in the [[Kit Reference]] documentation.		{{note}}Within things and picks, there are a number of pre-defined pseudo-fields that are always defined and that allow access to facets of the pick that are not governed by user-defined fields. These pseudo-fields behave like normal fields in all respects within scripts, except that some are read-only. The list of pre-defined fields can be found elsewhere in the [[Kit Reference]] documentation.
	\|-		\|-
	\|root		\|root
	\|Transitions to the [[Pick Context~~#transitions~~\|pick context]] corresponding to the root pick that bootstraps the current pick into the container. If the current pick is not bootstrapped, or if the current pick is designated as unique and can possess multiple bootstraps, the transition fails to resolve.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the root pick that bootstraps the current pick into the container. If the current pick is not bootstrapped, or if the current pick is designated as unique and can possess multiple bootstraps, the transition fails to resolve.<br>
	Example: this.source		Example: this.source
	\|-		\|-
	\|gearholder		\|gearholder
	\|Transitions to the [[Pick Context~~#transitions~~\|pick context]] corresponding to the pick that is assigned as the gear holder of the current pick. If the current pick is not held, the transition fails to resolve. If the current pick is not gear, an error is reported and the transition fails to resolve.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the pick that is assigned as the gear holder of the current pick. If the current pick is not held, the transition fails to resolve. If the current pick is not gear, an error is reported and the transition fails to resolve.<br>
	Example: this.gearholder		Example: this.gearholder
	\|-		\|-
	\|linkage[''id'']		\|linkage[''id'']
	\|Transitions to the [[Pick Context~~#transitions~~\|pick context]] corresponding to the linkage with the ''id'' specified. If the linkage is not defined, an error is reported.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the linkage with the ''id'' specified. If the linkage is not defined, an error is reported.<br>
	Example: this.linkage[mylink]		Example: this.linkage[mylink]
	\|-		\|-
	\|anchor		\|anchor
	\|Transitions to the [[Pick Context~~#transitions~~\|pick context]] corresponding to the pick within the master actor that attaches the current actor as a minion. If the pick does not reside within a minion, the transition fails to resolve.<br>		\|Transitions to the [[Pick Context\|pick context]] corresponding to the pick within the master actor that attaches the current actor as a minion. If the pick does not reside within a minion, the transition fails to resolve.<br>
	Example: this.anchor		Example: this.anchor
	\|-		\|-
	\|master		\|master
	\|Transitions to the [[Hero Context~~#transitions~~\|hero context]] corresponding to the master actor for which this pick's container is a minion. If the pick is not within a minion, the transition fails to resolve.<br>		\|Transitions to the [[Hero Context\|hero context]] corresponding to the master actor for which this pick's container is a minion. If the pick is not within a minion, the transition fails to resolve.<br>
	Example: this.master		Example: this.master
	\|-		\|-
	\|minion[''id'']		\|minion[''id'']
	\|Transitions to the [[Hero Context~~#transitions~~\|hero context]] corresponding to the minion actor with the given ''id'' that exists beneath the actor that possesses the current pick. The ''id'' can be omitted, in which case the minion is implicitly identified and must be directly attached by the current pick. If the pick does not reside within a master or the specified minion does not exist, the transition fails to resolve.<br>		\|Transitions to the [[Hero Context\|hero context]] corresponding to the minion actor with the given ''id'' that exists beneath the actor that possesses the current pick. The ''id'' can be omitted, in which case the minion is implicitly identified and must be directly attached by the current pick. If the pick does not reside within a master or the specified minion does not exist, the transition fails to resolve.<br>
	Example: this.minion[myminion]<br>		Example: this.minion[myminion]<br>
	Example: this.minion		Example: this.minion
	\|-		\|-
	\|herofield[''id'']		\|herofield[''id'']
	\|Transitions to the [[Field Context~~#transitions~~\|field context]] corresponding to the field given by ''id'' that exists on the "actor" pick for the containing actor. This is a shorthand notation for "hero.child[actor].field[id]".<br>		\|Transitions to the [[Field Context\|field context]] corresponding to the field given by ''id'' that exists on the "actor" pick for the containing actor. This is a shorthand notation for "hero.child[actor].field[id]".<br>
	Example: this.herofield[myfield]		Example: this.herofield[myfield]
	\|-		\|-
	\|usagepool[''id'']		\|usagepool[''id'']
	\|Transitions to the [[Pool Context~~#transitions~~\|pool context]] corresponding to the usage pool with the ''id'' specified for the current pick.<br>		\|Transitions to the [[Pool Context\|pool context]] corresponding to the usage pool with the ''id'' specified for the current pick.<br>
	Example: this.usagepool[mypool]		Example: this.usagepool[mypool]
	\|-		\|-
	\|shadow		\|shadow
	\|Transitions to the [[Container Context~~#transitions~~\|container context]] corresponding to the container into which the current pick is shadowed. If the pick is not shadowed, an error is reported and the transition fails to resolve.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the container into which the current pick is shadowed. If the pick is not shadowed, an error is reported and the transition fails to resolve.<br>
	Example: this.shadow		Example: this.shadow
	\|-		\|-
	\|origin		\|origin
	\|Transitions to the [[Container Context~~#transitions~~\|container context]] corresponding to the container into which the current pick was originally added. If the pick is displaced, the container is where the pick was added by the user. If not displaced, the container is simply the container for the pick.<br>		\|Transitions to the [[Container Context\|container context]] corresponding to the container into which the current pick was originally added. If the pick is displaced, the container is where the pick was added by the user. If not displaced, the container is simply the container for the pick.<br>
	Example: this.origin		Example: this.origin
	\|-		\|-