-
Notifications
You must be signed in to change notification settings - Fork 10
OryUIScrollBar
Creates a scroll bar and returns a scroll to top button ID. See Available Parameters section below for the options.
Deletes a scroll bar.
Returns the height of the scroll bar grip.
Returns whether or not the scroll bar grip is visible.
Returns the width of the scroll bar grip.
Returns the X position of the scroll bar grip.
Returns the Y position of the scroll bar grip.
Returns the height of the scroll bar track.
Returns the width of the scroll bar track.
Returns the X position of the scroll bar track.
Returns the Y position of the scroll bar track.
Hides the scroll bar.
Required to register activity with the scroll bar.
Sets the full size of the content that will be scrolled.
Shows the scroll bar.
Updates a scroll bar. See Available Parameters section below for the options.
| Parameter | Description |
|---|---|
| alwaysVisible | Whether or not the grip and track should always be visible. If false they will only appear when the screen is being dragged. Accepts the values true, false, 0, and 1. |
| autoResize | Whether or not the grip should auto resize based on the track height and content size. If false the values given for gripSize will be used. Accepts the values true, false, 0, and 1. |
| contentSize | The width and height of the full content, comma delimited. Accepts decimals. |
| depth | The depth of the scroll bar. |
| direction | The direction of the scroll bar. Accepts horizontal, horiz, vertical, and vert. |
| draggable | Whether or not the grip can be dragged. Accepts the values true, false, 0, and 1. |
| gripColor | The colour of the scroll bar grip. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes. |
| gripIcon | The icon to show on the scroll bar grip. See the list of Available Icons |
| gripIconColor | The colour of the scroll bar grip icon. Accepts RGB values, and RGBA values (comma delimited) Also accepts MakeColor() value/id, and hex color codes. |
| gripIconSize | The width and height of the grip icon, comma delimited. Also accepts -1 in either one to create a square icon. Accepts decimals. |
| gripPosition | The x and y position where the grip should be placed, comma delimited. |
| gripSize | The width and height of the grip, comma delimited. Also accepts -1 in either one to create a square grip. Accepts decimals. |
| invisibleGripSize | The width and height of an invisible grip that moves with the main grip, comma delimited. Also accepts -1 in either one to create a square button. Accepts decimals. A wider invisible grip makes it easier to touch and drag a visually thin grip. |
| minGripSize | The minimum width and height of the grip, comma delimited. If autoResize is true the grip will not go smaller than the minGripSize values. Accepts decimals. |
| scrollType | The type of scroll bar. Accepts the values fastscroll, and standard. |
| showGripIcon | Whether or not an icon should be shown on the grip. Accepts the values true, false, 0, and 1. |
| trackPosition | The x and y position where the track should be placed, comma delimited. |
| trackSize | The width and height of the track, comma delimited. Accepts decimals. |
scrollBar = OryUICreateScrollBar("alwaysVisible:false;autoResize:false;direction:vertical;draggable:true;scrollType:fastscroll")
OryUIUpdateScrollBar(scrollBar, "contentSize:100,300;trackPosition:93,20;trackSize:4.5,80;invisibleGripSize:8.5,7;gripSize:4.5,5;showGripIcon:true;gripIconSize:4,5")
do
OryUIStartTrackingTouch()
OryUIInsertScrollBarListener(scrollBar)
OryUIEndTrackingTouch()
Sync()
loop