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

guiScrollPaneSetHorizontalScrollPosition

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 is used to set the position of a horizontal scroll pane as a percentage.

Syntax

bool guiScrollPaneSetHorizontalScrollPosition ( element horizontalScrollPane, float position )
Required Arguments
  • horizontalScrollPane: The scroll pane you want to change the position of
  • position: a float ranging from 0 - 100

Returns

  • bool: value

Returns true if the position was set, false otherwise.

Code Examples

shared

This example sets the position of a scroll pane called "myScrollPane" created withguiCreateScrollPane, and outputs it to the chatbox.

if ( myScrollPane ) then -- if the scroll pane exist then
  -- set the position
        guiScrollPaneSetHorizontalScrollPosition( myScrollPane, 100 ) -- right end
        -- get the position
  local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
  -- output to the chatbox
  outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
       outputChatBox ("scroll pane not found!")
end

See Also

GUI Functions
GUI Elements
Reference