guiScrollBarGetScrollPosition | Multi Theft Auto: Wiki Skip to content

guiScrollBarGetScrollPosition

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 gets the scroll amount of a scrollbar as a percentage.

Syntax

float guiScrollBarGetScrollPosition ( gui-scrollBar theScrollBar )
Required Arguments
  • theScrollBar: The scrollbar you want to check.

Returns

  • float: value

Returns a float ranging between 0 and 100, representing the amount the scrollbar has been scrolled.

Code Examples

shared

This example outputs a message with the new scroll position when a scrollbar is scrolled.

function OnScroll( )
outputChatBox( "The new scroll position is " .. guiScrollBarGetScrollPosition( source ) )
end
addEventHandler( "onClientGUIScroll", root, OnScroll )

See Also

GUI Functions