guiCreateScrollBar | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

guiCreateScrollBar

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

Syntax

gui-scrollbar 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): whether sizes and positions are relative to their parent's. If this is true , then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.
  • parent (default: nil): the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

Returns

  • gui-scrollbar: value

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

Code Examples

shared 
function scBar()
    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.

See Also

GUI Functions
GUI Elements
Reference