GuiCreateScrollBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, bool relative, [gui-element parent = nil])
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, [ bool relative = false, gui-element parent = nil ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
[[Image:gui-scrollbar.png|frame|Example GUI scrollbar.]]
*'''x:''' the 2D x offset of the GUI scrollbar from its parent.  This is affected by the ''relative'' argument.
*'''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.
*'''y:''' the 2D y offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
Line 14: Line 15:
*'''height:''' the height 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'').
*'''horizontal:''' whether this scrollbar is horizontal (''true'') or vertical (''false'').
*'''relative:''' 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.


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}
*'''relative:''' 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:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.
*'''parent:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.


Line 23: Line 25:


==Example==
==Example==
[[Category:Needs Example]]
{{Client function}}
<syntaxhighlight lang="lua">
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.
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 08:05, 30 October 2023

This function creates a GUI scrollbar. You can use the functions guiScrollPaneSetHorizontalScrollPosition, guiScrollPaneSetVerticalScrollPosition, guiScrollPaneGetHorizontalScrollPosition and guiScrollPaneGetVerticalScrollPosition 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

Example GUI scrollbar.
  • 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. For more information on optional arguments, see optional arguments.

  • relative: 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: the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

Returns

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

Example

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

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateScrollBar?oldid=78472"