GuiScrollPaneGetVerticalScrollPosition

From Multi Theft Auto: Wiki
Jump to: navigation, search

This function is used to get the position of a vertical scroll pane as a percentage.

Syntax

float guiScrollPaneGetVerticalScrollPosition ( element verticalScrollPane )

Required Arguments

  • verticalScrollPane: The scroll pane you want to know the position of

Returns

Returns a float ranging between 0 and 100, or false otherwise.

Example

This example gets the position of a scroll pane called "myScrollPane" created with guiCreateScrollPane, and outputs it to the chatbox.

if ( myScrollPane ) then -- if the scroll pane exist then
        -- get the position
	local position = guiScrollPaneGetVerticalScrollPosition( 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

Browsers

Buttons

Checkboxes

Comboboxes

Edit Fields

FROM VERSION 1.5.5 r12419 ONWARDS

Gridlists

Memos

FROM VERSION 1.5.5 r12419 ONWARDS

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

GUI events