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

guiScrollBarSetScrollPosition

Client-side
Server-side
Shared

Pair: guiScrollBarGetScrollPosition

This function is used to set the scroll amount of a scrollbar as a percentage.

OOP Syntax Help! I don't understand this!

  • Method:gui-scrollbar:setScrollPosition(...)
  • Variable: .scrollPosition

Syntax 

​bool guiScrollBarSetScrollPosition ( ​gui-scrollbar theScrollBar, ​float amount )
Required arguments
  • theScrollBar: The scrollbar you want to change the progress of.
  • amount: A float ranging from 0 - 100 representing the amount you wish to set the scroll bar.

Returns

Returns true if the scroll position was successfully set, false otherwise.

  • bool: result

Code Examples

client

In this example, you can set the scrolling position using the command /pos <amount>.

local window = guiCreateWindow(0.3, 0.3, 0.3, 0.3, "Scroll-Position", true)
local scroll_bar = guiCreateScrollBar(5, 25, 30, 245, false, false, window)


function scroll_bar_setPos(_, position)
    if (tonumber(position)) then -- If we have typed a position
        guiScrollBarSetScrollPosition(scroll_bar, position) -- Set the position in the scroll bar
    end
end
addCommandHandler("pos", scroll_bar_setPos)

See Also

GUI Functions
GUI Elements
Reference
Functions
List of all client-side, server-side and shared functions
Events
List of all client-side and server-side events
Elements
List of all element types and their properties
OOP
Information about MTA object-oriented programming
Discord
Ask questions and chat live with the community.
Forum
Engage with the community in the old-fashioned way.