GuiCreateScrollPane: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(relative is optional, normal value is false)
 
(7 intermediate revisions by 5 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This creates a GUI scroll pane.
This creates a GUI scroll pane.
[[Image:gui-scrollpane.png|frame|Example GUI ScrollPane.]]


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateScrollPane( float x, float y, float width, float height, bool relative, [gui-element parent = nil])
element guiCreateScrollPane( float x, float y, float width, float height, [ bool relative = false, gui-element parent = nil])
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''x:''' the 2D x offset of the GUI scrollpane from its parent. This is affected by the relative argument.
*'''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 scrollbar 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.
*'''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.
*'''height:''' the height of the GUI scrollpane. This is affected by the relative argument.
*'''relative:''' 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.


===Optional Arguments===
===Optional Arguments===
{{OptionalArg}}
*'''relative:''' 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:''' the gui-element this scrollpane is attached to. By default, it is nil, meaning the widget is attached to the background.
*'''parent:''' the gui-element this scrollpane is attached to. By default, it is nil, meaning the widget is attached to the background.


Line 22: Line 24:


==Example==  
==Example==  
<section name="Client" class="client" show="true">
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.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Add example..
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
)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
{{GUI_events}}

Latest revision as of 08:06, 30 October 2023

This creates a GUI scroll pane.

Example GUI ScrollPane.

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. For more information on optional arguments, see optional arguments.

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

Returns

The gui-element if created, otherwise false.

Example

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

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateScrollPane?oldid=78473"