Difference between revisions of "Scene Target References"

From HLKitWiki
Jump to: navigation, search
Line 5: Line 5:
 
:{| class="infotable"
 
:{| class="infotable"
 
|class="leftnormal"|width
 
|class="leftnormal"|width
|(Left, Right, Number)  
+
|(Left, Right, Number) Accesses the width of the scene. The width of panels and sheets is properly setup by HL and any changes are completely ignored, as HL wholly controls the rendering region for panels and sheets. For forms, the width is initialized to something safe by HL, but the author is assumed to set the width appropriately for the contents that need to be displayed.<br>
 +
Example: result = this.width<br>
 +
Example: this.width = 420
 
|-
 
|-
 
|height
 
|height
|(Left, Right, Number)  
+
|(Left, Right, Number) Accesses the height of the scene. The height of panels and sheets is properly setup by HL and any changes are completely ignored, as HL wholly controls the rendering region for panels and sheets. For forms, the height is initialized to something safe by HL, but the author is assumed to set the height appropriately for the contents that need to be displayed.<br>
 +
Example: result = this.height<br>
 +
Example: this.height = 420
 
|-
 
|-
 
|scrollbar
 
|scrollbar
|(Right, Number)  
+
|(Right, Number) Returns the width of a scroller, in pixels.<br>
 +
Example: result = this.scrollbar
 
|-
 
|-
 
|defwidth
 
|defwidth

Revision as of 22:03, 6 December 2008

Context: HL KitKit Reference … Target References 

The "scene" script context applies equally to panels, forms, and sheets. However, there are some important behavioral differences between those three visual elements that impact how certain target references operate for each, and those different are detailed below. The complete list of target references for scenes is presented in the table below.

width (Left, Right, Number) Accesses the width of the scene. The width of panels and sheets is properly setup by HL and any changes are completely ignored, as HL wholly controls the rendering region for panels and sheets. For forms, the width is initialized to something safe by HL, but the author is assumed to set the width appropriately for the contents that need to be displayed.

Example: result = this.width
Example: this.width = 420

height (Left, Right, Number) Accesses the height of the scene. The height of panels and sheets is properly setup by HL and any changes are completely ignored, as HL wholly controls the rendering region for panels and sheets. For forms, the height is initialized to something safe by HL, but the author is assumed to set the height appropriately for the contents that need to be displayed.

Example: result = this.height
Example: this.height = 420

scrollbar (Right, Number) Returns the width of a scroller, in pixels.

Example: result = this.scrollbar

defwidth (Right, Number)
defheight (Right, Number)
minwidth (Left, Right, Number)
minheight (Left, Right, Number)
maxwidth (Left, Right, Number)
maxheight (Left, Right, Number)
autotop (Left, Right, Number)
autobottom (Left, Right, Number)
autoleft (Left, Right, Number)
autoright (Left, Right, Number)
autowidth (Left, Right, Number)
autoheight (Left, Right, Number)
autogap (Left, Right, Number)
autoplace[gap] (Right, Number)