Difference between revisions of "Container Target References"
From HLKitWiki
| Line 7: | Line 7: | ||
:{| class="infotable" | :{| class="infotable" | ||
|class="leftnormal"|live | |class="leftnormal"|live | ||
| − | |(Read-Only) Returns | + | |(Read-Only) Returns non-zero if the container is currently considered "live", else zero if non-live. The live state for a gizmo is dictated by the live state of its parent pick that attaches it, while a hero is always considered live.<br> |
| − | Example: | + | Example: this.live. |
|- | |- | ||
|ishero | |ishero | ||
| − | |(Read-Only) Returns | + | |(Read-Only) Returns non-zero if the container is a hero, else zero for a gizmo.<br> |
| − | Example: | + | Example: this.ishero. |
|- | |- | ||
|isactive | |isactive | ||
| − | | | + | |(Read-Only) Returns non-zero if the container either is or resides within the currently active actor within the HL interface. If the container is or resides within a different actor, zero is returned.<br> |
| + | Example: this.isactive. | ||
|- | |- | ||
|assign[''tag''] | |assign[''tag''] | ||
| − | | | + | |(Read-Only) Assigns the indicated ''tag'' to the container. The tag must be specified using the standard "group.id" syntax. The tag is verified to exist during compilation of the script. Always returns a value of zero.<br> |
| + | Example: this.assign[skill.appraise]. | ||
|- | |- | ||
|delete[''tmpl''] | |delete[''tmpl''] | ||
| − | | | + | |(Read-Only) Deletes all tags from the container that match the tag template ''tmpl''. The template must use the standard "group.id" syntax and may contain a wildcard. If the template employs a wildcard, all tags matching the template are deleted. If the template specifies an explicit tag, and the tag has been assigned to the container multiple times, the tag is deleted only once, thereby providing detailed control to authors when needed. Always returns a value of zero.<br> |
| + | Example: this.delete[skill.craft?]. | ||
|- | |- | ||
|assignstr[''str''] | |assignstr[''str''] | ||
| − | | | + | |(Read-Only) This target reference is identical to "assign", except that the ''str'' parameter is a string expression that is evaluated within the script. This allows the tag to be dynamically determined via the script instead of being hard-wired at compilation. Always returns a value of zero.<br> |
| + | Example: this.assignstr[skill.appraise]. | ||
|- | |- | ||
|deletestr[''str''] | |deletestr[''str''] | ||
| − | | | + | |(Read-Only) This target reference is identical to "delete", 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. Always returns a value of zero.<br> |
| + | Example: this.deletestr["skill.craft?"]. | ||
|- | |- | ||
|tagis[''tmpl''] | |tagis[''tmpl''] | ||
Revision as of 05:18, 5 December 2008
Context: HL Kit … 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.
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.
live (Read-Only) Returns non-zero if the container is currently considered "live", else zero if non-live. The live state for a gizmo is dictated by the live state of its parent pick that attaches it, while a hero is always considered live.
Example: this.live.
ishero (Read-Only) Returns non-zero if the container is a hero, else zero for a gizmo.
Example: this.ishero.
isactive (Read-Only) Returns non-zero if the container either is or resides within the currently active actor within the HL interface. If the container is or resides within a different actor, zero is returned.
Example: this.isactive.
assign[tag] (Read-Only) Assigns the indicated tag to the container. The tag must be specified using the standard "group.id" syntax. The tag is verified to exist during compilation of the script. Always returns a value of zero.
Example: this.assign[skill.appraise].
delete[tmpl] (Read-Only) Deletes all tags from the container that match the tag template tmpl. The template must use the standard "group.id" syntax and may contain a wildcard. If the template employs a wildcard, all tags matching the template are deleted. If the template specifies an explicit tag, and the tag has been assigned to the container multiple times, the tag is deleted only once, thereby providing detailed control to authors when needed. Always returns a value of zero.
Example: this.delete[skill.craft?].
assignstr[str] (Read-Only) This target reference is identical to "assign", except that the str parameter is a string expression that is evaluated within the script. This allows the tag to be dynamically determined via the script instead of being hard-wired at compilation. Always returns a value of zero.
Example: this.assignstr[skill.appraise].
deletestr[str] (Read-Only) This target reference is identical to "delete", 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. Always returns a value of zero.
Example: this.deletestr["skill.craft?"].
tagis[tmpl] tagcount[tmpl] tagvalue[tmpl] tagmax[tmpl] tagmin[tmpl] tagexpr[expr] taguniquestr[str] tagcountstr[str] tagvaluestr[str] tagmaxstr[str] tagminstr[str] taguniquestr[str] tagexprstr[str] livename actorname playername tagmatch[refgrp,match,ref] tagsearch[str] intersect[src,targ] inherit[id] tagnames[tmpl,delim] tagabbrevs[tmpl,delim] tagids[tmpl,delim] childexists[id] childlives[id] childcount[id] haschild[str] isidentity[grp] setidentity[grp] countidentity[grp] setactor foreach isminion ismaster hasminion[id] miniontext sourcetree isdynalink[expr] istransact weight (Read-Only) Returns the total weight of all "gear" picks within the container.
Example: "result = this.weight".
gearlist[delim,expr] geartree[expr] panelvalid[id] errorcount errorlist combatant initchange ismoveup ismovedown combatmove[expr] combatmovenow combatact combatdefer
