guiCreateScrollBar

Client-side

Server-side

Shared

This function creates a GUI scrollbar. You can use the functions guiScrollBarSetScrollPosition and guiScrollBarGetScrollPosition to read and modify the scrollbar's scroll.

OOP Syntax Help! I don't understand this!

Constructor: GuiScrollBar (...)

Syntax

gui-scrollbar|false guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, [ bool relative = false, gui-element parent = nil ] )

Required arguments

x: The 2D x offset of the GUI scrollbar from its parent. This is affected by the relative argument.
y: The 2D y offset of the GUI scrollbar from its parent. This is affected by the relative argument.
width: The width of the GUI scrollbar. This is affected by the relative argument.
height: The height of the GUI scrollbar. This is affected by the relative argument.
horizontal: Whether this scrollbar is horizontal (true) or vertical (false).

Optional arguments

Note: when using optional arguments, you might need to supply all arguments before the one you wish to use.

relative (default: false): This is whether sizes and positioning are relative. If this is true, then all x, y, width, height floats must be between 0 and 1, representing measures relative to the parent.
parent (default: nil): This is the parent that the scrollbar is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Returns

Returns a gui-scrollbar if it was created successfully, false otherwise.

gui-scrollbar|false: result

Code Examples

client

function scBar()
    local Window = guiCreateWindow(0.3664, 0.2764, 0.3508, 0.3477, "Window", true) -- We create a window.
    guiCreateScrollBar(15, 81, 24, 245, false, false, Window) -- We create a scrollbar as a child of 'Window'
end
addEventHandler("onClientResourceStart", resourceRoot, scBar) -- We handle it with 'onClientResourceStart' event.

Gallery

Click on the image to view the full preview along with the description.

guiCreateScrollBar

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Optional arguments

Returns

Code Examples

Gallery

See Also

GUI Functions

GUI Elements

Reference