Target References

Context: HL Kit … Kit Reference 

Overview

When managing data via scripts, the first step is to establish the correct script context. Once you've identified the desired context, you'll then need to specify the appropriate target reference to retrieve or manipulate the specific information you want. Every script context has an assortment of target references that provide access to data pertaining to that context.

NOTE! If the current script context is invalid, any target reference used within that context. If this occurs during run-time, the operation will be ignored and the target identifier will return zero. A suitable error will generally be displayed, but not always. An example of an invalid context is when a pick attempts to transition to a field that does not exist within that pick.

Target Reference Behaviors

Every target reference is assigned a set of behaviors that dictate how it can be used within scripts. The different behaviors are described in the table below.

Right	This target reference can be utilized on the right side of an assignment statement or with the "perform" statement. The value returned is specified within its description.
Left	This target reference can be utilized on the left side of an assignment statement. It must be assigned a value in accordance with its description.
Number	This target reference utilizes a numeric value, either returning a number or expecting to be assigned a number.
String	This target reference utilizes a text string, either returning a string or expecting to be assigned a string.

Topics

The topics below delineate the various target references that are available within each context.

• Container Target References
• Hero Target References
• Pick Target References
• Thing Target References
• Field Target References
• Pool Target References
• Scene Target References
• Layout Target References
• Template Target References
• Portal Target References
• Value Target References
• Table Target References
• State Target References