Difference between revisions of "GUIScrollBox"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the GUIScrollBox class)
(Documentation for the GUIScrollBox class)
Line 1: Line 1:
−
A component representing a scrollable surface.
 
−
 
 
*'''Inherits class: [[GUIPanel]]'''
 
*'''Inherits class: [[GUIPanel]]'''
 
* This is a JavaScript visible object
 
* This is a JavaScript visible object
Line 8: Line 6:
 
===Properties===
 
===Properties===
 
:{{CSharp|bool AlwaysShowHorizontal {get; set;} }}
 
:{{CSharp|bool AlwaysShowHorizontal {get; set;} }}
−
::
 
−
::Should the horizontal scrollbar always be visible
 
  
 
:{{CSharp|bool AlwaysShowVertical {get; set;} }}
 
:{{CSharp|bool AlwaysShowVertical {get; set;} }}
−
::
 
−
::Should the vertical scrollbar always be visible
 
  
 
:{{CSharp|GUIRectTransform Content {get; set;} }}
 
:{{CSharp|GUIRectTransform Content {get; set;} }}
−
::
 
−
::Reference to the RectTransform for the content area
 
  
 
:{{CSharp|float DecelerationRate {get; set;} }}
 
:{{CSharp|float DecelerationRate {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-decelerationRate.html
 
  
 
:{{CSharp|float Elasticity {get; set;} }}
 
:{{CSharp|float Elasticity {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-elasticity.html
 
  
 
:{{CSharp|int Height {get; set;} }}
 
:{{CSharp|int Height {get; set;} }}
 +
 
:{{CSharp|bool HorizontalMouseScroll {get; set;} }}
 
:{{CSharp|bool HorizontalMouseScroll {get; set;} }}
−
::
 
−
::Should rolling the mousewheel cause horizontal or vertical scroll?
 
  
 
:{{CSharp|GUISprite HorizontalScrollHandleSprite {get;} }}
 
:{{CSharp|GUISprite HorizontalScrollHandleSprite {get;} }}
−
::
 
−
::Reference to the sprite defining the backdrop of the horizontal scrollbar's handle
 
  
 
:{{CSharp|GUISprite HorizontalScrollSprite {get;} }}
 
:{{CSharp|GUISprite HorizontalScrollSprite {get;} }}
−
::
+
 
−
::Reference to the sprite defining the backdrop of the horizontal scrollbar
+
:{{CSharp|bool HorizontalScrollVisible {get;} }}
  
 
:{{CSharp|GUIRectTransform HorizontalScrollbar {get; set;} }}
 
:{{CSharp|GUIRectTransform HorizontalScrollbar {get; set;} }}
−
::
 
−
::Reference to the RectTransform for the horizontal scrollbar
 
  
 
:{{CSharp|bool HorizontalScrolling {get; set;} }}
 
:{{CSharp|bool HorizontalScrolling {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-horizontal.html
 
  
 
:{{CSharp|bool Inertia {get; set;} }}
 
:{{CSharp|bool Inertia {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-inertia.html
 
  
 
:{{CSharp|MovementType MovementType {get; set;} }}
 
:{{CSharp|MovementType MovementType {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-movementType.html
 
  
 
:{{CSharp|bool PreferContentHeight {get; set;} }}
 
:{{CSharp|bool PreferContentHeight {get; set;} }}
−
::
 
−
::Use the ContentHeight as this ScrollBox's preferredHeight
 
  
 
:{{CSharp|bool PreferContentWidth {get; set;} }}
 
:{{CSharp|bool PreferContentWidth {get; set;} }}
−
::
 
−
::Use the ContentWidth as this ScrollBox's preferredWidth
 
  
 
:{{CSharp|JSVector2 ScrollPos {get; set;} }}
 
:{{CSharp|JSVector2 ScrollPos {get; set;} }}
−
::
 
−
::The normalized scroll position of this surface from (0,0) to (1,1)
 
  
 
:{{CSharp|float ScrollSpeed {get; set;} }}
 
:{{CSharp|float ScrollSpeed {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-scrollSensitivity.html
 
  
 
:{{CSharp|GUISprite VerticalScrollHandleSprite {get;} }}
 
:{{CSharp|GUISprite VerticalScrollHandleSprite {get;} }}
−
::
 
−
::Reference to the sprite defining the backdrop of the vertical scrollbar's handle
 
  
 
:{{CSharp|GUISprite VerticalScrollSprite {get;} }}
 
:{{CSharp|GUISprite VerticalScrollSprite {get;} }}
−
::
+
 
−
::Reference to the sprite defining the backdrop of the vertical scrollbar
+
:{{CSharp|bool VerticalScrollVisible {get;} }}
  
 
:{{CSharp|GUIRectTransform VerticalScrollbar {get; set;} }}
 
:{{CSharp|GUIRectTransform VerticalScrollbar {get; set;} }}
−
::
 
−
::Reference to the RectTransform for the vertical scrollbar
 
  
 
:{{CSharp|bool VerticalScrolling {get; set;} }}
 
:{{CSharp|bool VerticalScrolling {get; set;} }}
−
::
 
−
::https://docs.unity3d.com/ScriptReference/UI.ScrollRect-vertical.html
 
  
 
:{{CSharp|int Width {get; set;} }}
 
:{{CSharp|int Width {get; set;} }}
 +
 
===Events===
 
===Events===
 
:{{CSharp|OnScroll()}}
 
:{{CSharp|OnScroll()}}
−
::
 
−
::Event called whenever this scrollbox changes its scroll position.
 
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Revision as of 12:49, 26 May 2017

  • Inherits class: GUIPanel
  • This is a JavaScript visible object

Remarks [edit]

Properties

bool AlwaysShowHorizontal {get; set;}
bool AlwaysShowVertical {get; set;}
GUIRectTransform Content {get; set;}
float DecelerationRate {get; set;}
float Elasticity {get; set;}
int Height {get; set;}
bool HorizontalMouseScroll {get; set;}
GUISprite HorizontalScrollHandleSprite {get;}
GUISprite HorizontalScrollSprite {get;}
bool HorizontalScrollVisible {get;}
GUIRectTransform HorizontalScrollbar {get; set;}
bool HorizontalScrolling {get; set;}
bool Inertia {get; set;}
MovementType MovementType {get; set;}
bool PreferContentHeight {get; set;}
bool PreferContentWidth {get; set;}
JSVector2 ScrollPos {get; set;}
float ScrollSpeed {get; set;}
GUISprite VerticalScrollHandleSprite {get;}
GUISprite VerticalScrollSprite {get;}
bool VerticalScrollVisible {get;}
GUIRectTransform VerticalScrollbar {get; set;}
bool VerticalScrolling {get; set;}
int Width {get; set;}

Events

OnScroll()


Retrieved from "http://wiki.virtualworldweb.com/index.php?title=GUIScrollBox&oldid=4422"