Difference between revisions of "Layout Target References"

From HLKitWiki
Jump to: navigation, search
 
Line 82: Line 82:
 
Example: perform this.autoplace[42]<br>
 
Example: perform this.autoplace[42]<br>
 
Example: perform this.autoplace
 
Example: perform this.autoplace
 +
|-
 +
|batchplace
 +
|(Right, Number) Automatically places all the portals and templates which were queued for [[Using Batch Placement|batch placement]] using the "batchadd" target.<br>
 +
Example: perform this.batchplace
 
|-
 
|-
 
|}
 
|}

Latest revision as of 22:39, 19 December 2013

Context: HL KitKit Reference … Target References 

See Also: Layout Context Transitions

The "layout" script context governs the operations that can be applied to layouts within scenes. The complete list of target references for layouts is presented in the table below.

width (Left, Right, Number) Accesses the width of the layout. Unless explicitly specified within the XML, the width of a layout is initialized to the width of the containing scene, minus any assigned margins.

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

height (Left, Right, Number) Accesses the height of the scene. Unless explicitly specified within the XML, the height of a layout is initialized to the height of the containing scene, minus any assigned margins.

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

left (Left, Right, Number) Accesses the position of the left edge of the layout within the containing visual element.

Example: result = this.left
Example: this.left = 42

top (Left, Right, Number) Accesses the position of the top edge of the layout within the containing visual element.

Example: result = this.top
Example: this.top = 42

right (Right, Number) Returns the position of the right edge of the layout within the containing visual element.

Example: result = this.right

bottom (Right, Number) Returns the position of the bottom edge of the layout within the containing visual element.

Example: result = this.bottom

visible (Left, Right, Number) Controls the visibility of the layout within the containing visual element. A non-zero value indicates the layout is visible and a zero value indicates hidden.

Example: result = this.visible
Example: this.visible = 1

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

Example: result = this.scrollbar

autotop (Left, Right, Number) Accesses the position of the top edge of the auto-place region within the containing visual element.

Example: result = this.autotop
Example: this.autotop = 42

autobottom (Left, Right, Number) Accesses the position of the bottom edge of the auto-place region within the containing visual element.

Example: result = this.autobottom
Example: this.autobottom = 420

autoleft (Left, Right, Number) Accesses the position of the left edge of the auto-place region within the containing visual element.

Example: result = this.autoleft
Example: this.autoleft = 42

autoright (Left, Right, Number) Accesses the position of the right edge of the auto-place region within the containing visual element.

Example: result = this.autoright
Example: this.autoright = 420

autowidth (Left, Right, Number) Accesses the width of the auto-place region within the containing visual element.

Example: result = this.autowidth
Example: this.autowidth = 420

autoheight (Left, Right, Number) Accesses the height of the auto-place region within the containing visual element.

Example: result = this.autoheight
Example: this.autoheight = 420

autogap (Left, Right, Number) Accesses the default gap size used when automatically placing elements within the containing visual element. The "autogap" defaults to zero.

Example: result = this.autogap
Example: this.autogap = 42

autoplace[gap] (Right, Number) Automatically places the layout within the containing visual element, subject to the standard rules for automatic placement. The gap parameter specifies the gap to be used between this layout and the previous placed element. The parameter can be omitted, in which case the established "autogap" is utilized. A value of zero is always returned.

Example: perform this.autoplace[42]
Example: perform this.autoplace

batchplace (Right, Number) Automatically places all the portals and templates which were queued for batch placement using the "batchadd" target.

Example: perform this.batchplace