GuiCreateScrollBar: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
(3 intermediate revisions by 3 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-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, [ bool relative = false, gui-element parent = nil ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 15: | 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''). | ||
===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 27: | Line 28: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function scBar() | function scBar() | ||
Window = guiCreateWindow(0.3664,0.2764,0.3508,0.3477,"Window",true)--We create a window. | 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 | end | ||
addEventHandler("onClientResourceStart", | addEventHandler("onClientResourceStart", resourceRoot, scBar) --We handle it with 'onClientResourceStart' event. | ||
</syntaxhighlight> | </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
- 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
- guiBringToFront
- getChatboxLayout
- getChatboxCharacterLimit
- guiCreateFont
- guiBlur
- guiFocus
- guiGetAlpha
- guiGetCursorType
- guiGetEnabled
- guiGetFont
- guiGetInputEnabled
- guiGetInputMode
- guiGetPosition
- guiGetProperties
- guiGetProperty
- guiGetScreenSize
- guiGetSize
- guiGetText
- guiGetVisible
- guiMoveToBack
- guiSetAlpha
- guiSetEnabled
- guiSetFont
- guiSetInputEnabled
- guiSetInputMode
- guiSetPosition
- guiSetProperty
- guiSetSize
- guiSetText
- guiSetVisible
- isChatBoxInputActive
- isConsoleActive
- isDebugViewActive
- isMainMenuActive
- isMTAWindowActive
- isTransferBoxActive
- setChatboxCharacterLimit
- setDebugViewActive
Browsers
Buttons
Checkboxes
Comboboxes
- guiCreateComboBox
- guiComboBoxAddItem
- guiComboBoxClear
- guiComboBoxGetItemCount
- guiComboBoxGetItemText
- guiComboBoxGetSelected
- guiComboBoxIsOpen
- guiComboBoxRemoveItem
- guiComboBoxSetItemText
- guiComboBoxSetOpen
- guiComboBoxSetSelected
Edit Boxes
- guiCreateEdit
- guiEditGetCaretIndex
- guiEditGetMaxLength
- guiEditIsMasked
- guiEditIsReadOnly
- guiEditSetCaretIndex
- guiEditSetMasked
- guiEditSetMaxLength
- guiEditSetReadOnly
Gridlists
- guiCreateGridList
- guiGridListAddColumn
- guiGridListAddRow
- guiGridListAutoSizeColumn
- guiGridListClear
- guiGridListGetColumnCount
- guiGridListGetColumnTitle
- guiGridListGetColumnWidth
- guiGridListGetHorizontalScrollPosition
- guiGridListGetItemColor
- guiGridListGetItemData
- guiGridListGetItemText
- guiGridListGetRowCount
- guiGridListGetSelectedCount
- guiGridListGetSelectedItem
- guiGridListGetSelectedItems
- guiGridListGetSelectionMode
- guiGridListIsSortingEnabled
- guiGridListGetVerticalScrollPosition
- guiGridListInsertRowAfter
- guiGridListRemoveColumn
- guiGridListRemoveRow
- guiGridListSetColumnTitle
- guiGridListSetColumnWidth
- guiGridListSetHorizontalScrollPosition
- guiGridListSetItemColor
- guiGridListSetItemData
- guiGridListSetItemText
- guiGridListSetScrollBars
- guiGridListSetSelectedItem
- guiGridListSetSelectionMode
- guiGridListSetSortingEnabled
- guiGridListSetVerticalScrollPosition
Memos
- guiCreateMemo
- guiMemoGetCaretIndex
- guiMemoGetVerticalScrollPosition
- guiMemoSetVerticalScrollPosition
- guiMemoIsReadOnly
- guiMemoSetCaretIndex
- guiMemoSetReadOnly
Progressbars
Radio Buttons
Scrollbars
Scrollpanes
- guiCreateScrollPane
- guiScrollPaneGetHorizontalScrollPosition
- guiScrollPaneGetVerticalScrollPosition
- guiScrollPaneSetHorizontalScrollPosition
- guiScrollPaneSetScrollBars
- guiScrollPaneSetVerticalScrollPosition
Static Images
Tab Panels
Tabs
Text Labels
- guiCreateLabel
- guiLabelGetColor
- guiLabelGetFontHeight
- guiLabelGetTextExtent
- guiLabelSetColor
- guiLabelSetHorizontalAlign
- guiLabelSetVerticalAlign
Windows
Input
GUI
- onClientGUIAccepted
- onClientGUIBlur
- onClientGUIChanged
- onClientGUIClick
- onClientGUIComboBoxAccepted
- onClientGUIDoubleClick
- onClientGUIFocus
- onClientGUIMouseDown
- onClientGUIMouseUp
- onClientGUIMove
- onClientGUIScroll
- onClientGUISize
- onClientGUITabSwitched
- onClientMouseEnter
- onClientMouseLeave
- onClientMouseMove
- onClientMouseWheel