GUIScrollBox
From Virtual World Web Wiki
Revision as of 12:11, 30 April 2019 by Spark5 (Talk | contribs) (Documentation for the GUIScrollBox class)
A component representing a scrollable surface.
- Inherits class: GUIPanel
- This is a JavaScript visible object
Remarks [edit]
Properties
- bool AlwaysShowHorizontal {get; set;}
- Should the horizontal scrollbar always be visible
- bool AlwaysShowVertical {get; set;}
- Should the vertical scrollbar always be visible
- GUIRectTransform Content {get; set;}
- Reference to the RectTransform for the content area
- float DecelerationRate {get; set;}
- float Elasticity {get; set;}
- int Height {get; set;}
- bool HorizontalMouseScroll {get; set;}
- Should rolling the mousewheel cause horizontal or vertical scroll?
- GUISprite HorizontalScrollHandleSprite {get;}
- Reference to the sprite defining the backdrop of the horizontal scrollbar's handle
- GUISprite HorizontalScrollSprite {get;}
- Reference to the sprite defining the backdrop of the horizontal scrollbar
- bool HorizontalScrollVisible {get;}
- Is the horizontal scroll bar currently visible
- GUIRectTransform HorizontalScrollbar {get; set;}
- Reference to the RectTransform for the horizontal scrollbar
- float HorizontalScrollbarSpacing {get; set;}
- bool HorizontalScrolling {get; set;}
- bool Inertia {get; set;}
- MovementType MovementType {get; set;}
- bool PreferContentHeight {get; set;}
- Use the ContentHeight as this ScrollBox's preferredHeight
- bool PreferContentWidth {get; set;}
- Use the ContentWidth as this ScrollBox's preferredWidth
- JSVector2 ScrollPos {get; set;}
- The normalized scroll position of this surface from (0,0) to (1,1)
- float ScrollSpeed {get; set;}
- GUISprite VerticalScrollHandleSprite {get;}
- Reference to the sprite defining the backdrop of the vertical scrollbar's handle
- GUISprite VerticalScrollSprite {get;}
- Reference to the sprite defining the backdrop of the vertical scrollbar
- bool VerticalScrollVisible {get;}
- Is the horizontal scroll bar currently visible
- GUIRectTransform VerticalScrollbar {get; set;}
- Reference to the RectTransform for the vertical scrollbar
- float VerticalScrollbarSpacing {get; set;}
- bool VerticalScrolling {get; set;}
- int Width {get; set;}
Events
- OnScroll()
- Event called whenever this scrollbox changes its scroll position.