Pick Context

From HLKitWiki
Revision as of 06:01, 7 December 2008 by Rob (Talk | contribs) (New page: {{context|Kit Reference|Context Transitions}} See Also: Pick Target References From within a "pick" context, you can utilize the following set of valid context transitions: :{| clas...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Context: HL KitKit Reference … Context Transitions 

See Also: Pick Target References

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

state Transitions to the state context.

Example: this.state

hero Transitions to the hero context corresponding to the hero that contains the current pick.

Example: this.hero

container Transitions to the container context corresponding to the immediate container of the current pick, whether it be a hero or a gizmo.

Example: this.container

parent Transitions to the container context corresponding to the immediate container of the current pick, just like the "container" transition.

Example: this.parent

gizmo Transitions to the 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.

Example: this.gizmo

field[id] Transitions to the 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.

Example: this.field[myfield]
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 Transitions to the 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.

Example: this.source

gearholder Transitions to the 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.

Example: this.gearholder

linkage[id] Transitions to the pick context corresponding to the linkage with the id specified. If the linkage is not defined, an error is reported.

Example: this.linkage[mylink]

anchor Transitions to the 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.

Example: this.anchor

master Transitions to the 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.

Example: this.master

minion[id] Transitions to the 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.

Example: this.minion[myminion]
Example: this.minion

herofield[id] Transitions to the 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]".

Example: this.herofield[myfield]

usagepool[id] Transitions to the pool context corresponding to the usage pool with the id specified for the current pick.

Example: this.usagepool[mypool]

shadow Transitions to the 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.

Example: this.shadow

origin Transitions to the 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.

Example: this.origin