Difference between revisions of "Script Contexts"

From HLKitWiki
Jump to: navigation, search
Line 38: Line 38:
 
|-
 
|-
 
|}
 
|}
#define TERM_CHILD_CONTEXT      (SCRIPT_BASE + 32)
 
#define TERM_GIZMO_CONTEXT      (SCRIPT_BASE + 39)
 
#define TERM_CHILDFOUND_CONTEXT (SCRIPT_BASE + 43)
 
#define TERM_FIRSTCHILD_CONTEXT (SCRIPT_BASE + 47)
 
  
 
There are also quite a few specialized contexts within the structural hierarchy. Each of these contexts actually maps to one of the basic contexts above, but it is considered distinct due to added restrictions or limitations on what can be done within the context.
 
There are also quite a few specialized contexts within the structural hierarchy. Each of these contexts actually maps to one of the basic contexts above, but it is considered distinct due to added restrictions or limitations on what can be done within the context.
Line 76: Line 72:
 
|x
 
|x
 
|-
 
|-
|x
+
|child
 
|x
 
|x
 
|-
 
|-
|x
+
|gizmo
 
|x
 
|x
 
|-
 
|-

Revision as of 23:11, 3 December 2008

Context: HL KitKit Reference 

Overview

This first step in accessing data via scripts is in identifying where that data resides within the overall data hierarchy. A separate hierarchy is maintained for both structural information (e.g. actors, picks, gizmos, minions, etc.) and visual information (e.g. panels, layouts, templates, etc.). Each different layer within the hierarchy is considered a distinct "context".

Contexts Within Structural Hierarchy

Within the structural hierarchy, there are a variety of contexts managed by the Kit. The following table identifies these contexts and provides a brief description of what each represents.

portfolio x
hero x
container x
pick x
field x
pool x
x x
x x
x x

There are also quite a few specialized contexts within the structural hierarchy. Each of these contexts actually maps to one of the basic contexts above, but it is considered distinct due to added restrictions or limitations on what can be done within the context.

parent x
linkage x
root x
dynamiclink x
gearholder x
shadow x
origin x
master x
minion x
anchor x
child x
gizmo x

Contexts Within Visual Hierarchy

The visual hierarchy has a separate set of contexts that are managed by the Kit. The following table describes each of these contexts.

scene x
layout x
template x
portal x
value x
table x
chosen x
hero x
container x

General Contexts

In addition to the structural and visual contexts, the Kit supports contexts that are outside of the the normal hierarchy. These general contexts are described in the table below.

state x
transaction x
focus x
eachpick x
altpick x
altthing x
x x
x x
x x