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

guiCreateScrollPane

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 creates a GUI scroll pane.

Syntax

element guiCreateScrollPane ( float x, float y, float width, float height, [ bool relative = false, gui-element parent = nil ] )
Required Arguments
  • x: the 2D x offset of the GUI scrollpane from its parent. This is affected by the relative argument.
  • y: the 2D y offset of the GUI scrollpane from its parent. This is affected by the relative argument.
  • width: the width of the GUI scrollpane. This is affected by the relative argument.
  • height: the height of the GUI scrollpane. This is affected by the relative argument.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • relative (default: false): 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 (default: nil): the gui-element this scrollpane is attached to. By default, it is nil, meaning the widget is attached to the background.

Returns

  • element: value

The gui-element if created, otherwise false.

Code Examples

shared

This example creates a small window with a scrollpane on. Using the /fill command you can populate the scrollpane with the names of every player in the server.

addEventHandler("onClientResourceStart",resourceRoot,
  function()
    -- create a window and create a scrollpane on it
    local window = guiCreateWindow(5,5,130,150,"",false)
    -- the width and height values here are largely irrelevant as the scrollpane will automatically resize when needed
    scrollpane = guiCreateScrollPane(0,0,130,150,false,window)
  end
)


addCommandHandler("fill",
  function()
    -- if the scrollpane exists
    if scrollpane then
      -- delete all the existing labels
      for i,v in ipairs(getElementChildren(scrollpane)) do
        destroyElement(v)
      end


      -- for every player in the server
      for i,v in ipairs(getElementsByType("player")) do
        -- create a label with their name on the scrollpane
        guiCreateLabel(5,i*20,90,20,tostring(getPlayerName(v)),false,scrollpane)
      end
    end
  end
)

See Also

GUI Functions
GUI Elements
Reference