GuiCreateGridList - Revision history

IManGaaX at 08:09, 30 October 2023

2023-10-30T08:09:43Z

← Older revision		Revision as of 08:09, 30 October 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element guiCreateGridList ( float x, float y, float width, float height, [ bool relative = false, element parent = nil ] )		element guiCreateGridList ( float x, float y, float width, float height, [ bool relative = false, gui-element parent = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/GUI/Gridlist\|GuiGridList]]}}		{{OOP\|\|[[Element/GUI/Gridlist\|GuiGridList]]}}

IManGaaX: relative is optional, normal value is false

2023-10-30T07:51:59Z

relative is optional, normal value is false

← Older revision		Revision as of 07:51, 30 October 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element guiCreateGridList ( float x, float y, float width, float height, bool relative, [ element parent = nil ] )		element guiCreateGridList ( float x, float y, float width, float height, [ bool relative = false, element parent = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/GUI/Gridlist\|GuiGridList]]}}		{{OOP\|\|[[Element/GUI/Gridlist\|GuiGridList]]}}
Line 15:		Line 15:
	*'''width:''' A float of the width of the GUI gridlist. This is affected by the ''relative'' argument.		*'''width:''' A float of the width of the GUI gridlist. This is affected by the ''relative'' argument.
	*'''height:''' A float of the height of the GUI gridlist. This is affected by the ''relative'' argument.		*'''height:''' A float of the height of the GUI gridlist. This is affected by the ''relative'' argument.
	*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
			*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.
	*'''parent:''' This is the parent that the gui gridlist is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.		*'''parent:''' This is the parent that the gui gridlist is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Tails: Simplified examples

2018-09-01T21:54:42Z

Simplified examples

← Older revision		Revision as of 21:54, 1 September 2018
Line 27:		Line 27:
	'''Example 1:''' This example creates a player list on the right of the screen with 1 column and fills it		'''Example 1:''' This example creates a player list on the right of the screen with 1 column and fills it
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~function createPlayerList ()~~		local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
	~~--Create the grid list element~~		guiGridListAddColumn(playerList, "Player", 0.85)
	local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
	~~--Create a players column in the list~~		for _, player in ipairs(getElementsByType("player")) do
	~~local column =~~ guiGridListAddColumn(playerList, "Player", 0.85)		guiGridListAddRow(playerList, getPlayerName(player))
	~~if (column) then --If the column has been created, fill it with players~~
	for id, player in ipairs(getElementsByType("player")) do
	~~local row =~~ guiGridListAddRow~~(playerList)~~
	~~guiGridListSetItemText~~(playerList~~, row, column~~, getPlayerName(player)~~, false, false~~ )
	~~end~~
	~~end~~
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' Using [[OOP]] we can write ~~much~~ shorter and cleaner code (Requires <oop>true<oop> in the meta file). This ~~example~~ creates a player list with 2 columns.		'''Example 2:''' Using [[OOP]] we can write shorter and cleaner code (Requires <oop>true<oop> in the meta file). This creates a player list with 2 columns.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local list = GuiGridList(0.80, 0.40, 0.15, 0.35, true)		local list = GuiGridList(0.80, 0.40, 0.15, 0.35, true)
Line 47:		Line 41:
	list:addColumn("name", 0.75)		list:addColumn("name", 0.75)

	for i, player in ~~pairs~~(getElementsByType("player")) do		for index, player in ipairs(getElementsByType("player")) do
	list:addRow(i, player~~:getName()~~)		list:addRow(index, player.name)
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Tails at 22:37, 26 May 2018

2018-05-26T22:37:10Z

@@ Line 50: / Line 50: @@
 	list:addRow(i, player:getName())
 end
 </syntaxhighlight>

Tails: added oop example

2018-05-26T18:14:22Z

added oop example

← Older revision		Revision as of 18:14, 26 May 2018
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element guiCreateGridList ( float x, float y, float width, float height, bool relative, [ element parent = nil ] )		element guiCreateGridList ( float x, float y, float width, float height, bool relative, [ element parent = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[Element/GUI/Gridlist\|GuiGridList]]}}

	===Required Arguments===		===Required Arguments===
Line 23:		Line 24:
	Returns an element of the created gridlist if it was successfully created, false otherwise.		Returns an element of the created gridlist if it was successfully created, false otherwise.

	==Example==		==Example==
	'''Example 1:''' This example creates a player list on the right of the screen and fills it		'''Example 1:''' This example creates a player list on the right of the screen with 1 column and fills it
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function createPlayerList ()		function createPlayerList ()
	--Create the grid list element		--Create the grid list element
	local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )		local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
	--Create a players column in the list		--Create a players column in the list
	local column = guiGridListAddColumn( playerList, "Player", 0.85 )		local column = guiGridListAddColumn(playerList, "Player", 0.85)
	if ( column ) then --If the column has been created, fill it with players		if (column) then --If the column has been created, fill it with players
	for id, player in ipairs(getElementsByType("player")) do		for id, player in ipairs(getElementsByType("player")) do
	local row = guiGridListAddRow ( playerList )		local row = guiGridListAddRow(playerList)
	guiGridListSetItemText ( playerList, row, column, getPlayerName ( player ), false, false )		guiGridListSetItemText(playerList, row, column, getPlayerName(player), false, false )
	end		end
	end		end
Line 40:		Line 41:
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This example creates a weapon selection screen, complete with a window, gridlist and a button. Users can select a shotgun or a machine gun. The window is not movable or sizable.		'''Example 2:''' Using [[OOP]] we can write much shorter and cleaner code (Requires <oop>true<oop> in the meta file). This example creates a player list with 2 columns.
			<syntaxhighlight lang="lua">
			local list = GuiGridList(0.80, 0.40, 0.15, 0.35, true)
			list:addColumn("#", 0.15)
			list:addColumn("name", 0.75)

			for i, player in pairs(getElementsByType("player")) do
			list:addRow(i, player:getName())
			end
			</syntaxhighlight>

			'''Example 3:''' This example creates a weapon selection screen, complete with a window, gridlist and a button. Users can select a shotgun or a machine gun. The window is not movable or sizable.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--Setup some tables		--Setup some tables

LordHenry: /* See Also */

2018-05-20T14:06:19Z

Ccw at 05:10, 19 July 2011

2011-07-19T05:10:18Z

← Older revision		Revision as of 05:10, 19 July 2011
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
			[[Image:Gui-gridlist.png\|frame\|Example GUI gridlist.]]
	*'''x:''' A float of the 2D x position of the GUI gridlist on a player's screen. This is affected by the ''relative'' argument.		*'''x:''' A float of the 2D x position of the GUI gridlist on a player's screen. This is affected by the ''relative'' argument.
	*'''y:''' A float of the 2D y position of the GUI gridlist on a player's screen. This is affected by the ''relative'' argument.		*'''y:''' A float of the 2D y position of the GUI gridlist on a player's screen. This is affected by the ''relative'' argument.

Sebassje at 22:04, 5 September 2009

2009-09-05T22:04:00Z

← Older revision		Revision as of 22:04, 5 September 2009
Line 52:		Line 52:
	}		}

	function setupWeaponSelection ( ~~theResource~~ )		function setupWeaponSelection ()
	~~if theResource ~= getThisResource() then return end --if the resource started is not this one, dont bother creating the gui~~
	---Create a window for our spawnscreen, with the title "Select your weaposn".		---Create a window for our spawnscreen, with the title "Select your weaposn".
	spawnScreenMenu = guiCreateWindow ( 0.15, 0.33, 0.7, 0.34, "Select your weapons", true )		spawnScreenMenu = guiCreateWindow ( 0.15, 0.33, 0.7, 0.34, "Select your weapons", true )
Line 83:		Line 82:
	end		end
	end		end
	addEventHandler ( "onClientResourceStart", ~~getRootElement~~(), setupWeaponSelection )		addEventHandler ( "onClientResourceStart", getResourceRootElement(), setupWeaponSelection )
	</syntaxhighlight>		</syntaxhighlight>

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

R3mp at 20:33, 2 January 2009

2009-01-02T20:33:27Z

← Older revision		Revision as of 20:33, 2 January 2009
Line 17:		Line 17:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''parent:''' This is the parent that the gui gridlist is attached to. ~~The~~ ''relative'' argument ~~must be~~ true ~~to use this. Sizes~~ and positioning will be made relative to this parent. If no parent is passed, the parent will become the screen - causing ~~relative~~ positioning and sizing according to screen positioning.		*'''parent:''' This is the parent that the gui gridlist is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

	===Returns===		===Returns===

Talidan at 22:02, 4 August 2007

2007-08-04T22:02:31Z

← Older revision		Revision as of 22:02, 4 August 2007
Line 39:		Line 39:
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This example creates a weapon selection screen, complete with a window, gridlist and a button. Users can select a ~~handgun and an uzi~~. The window is not movable or sizable.		'''Example 2:''' This example creates a weapon selection screen, complete with a window, gridlist and a button. Users can select a shotgun or a machine gun. The window is not movable or sizable.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--Setup some tables		--Setup some tables
	~~handguns~~ = {		shotguns = {
	"~~colt45~~",		"chrome",
	"~~deagle~~",		"sawn-off",
	"~~silenced~~" }		"combat" }

	~~uzis~~ = {		machineGun = {
	"~~Uzi~~",		"m4",
	"~~MP5~~",		"ak-47"
	~~"Tec-9"~~ }		}

	function setupWeaponSelection ( theResource )		function setupWeaponSelection ( theResource )
	if theResource ~= getThisResource() then return end --if the resource started is not this one, dont bother creating the gui		if theResource ~= getThisResource() then return end --if the resource started is not this one, dont bother creating the gui
	---Create a window for our spawnscreen, with the title "Select your weaposn".		---Create a window for our spawnscreen, with the title "Select your weaposn".
	spawnScreenMenu = guiCreateWindow ( 0.15, 0.33, 0.7, 0.34, "Select your weapons", true )		spawnScreenMenu = guiCreateWindow ( 0.15, 0.33, 0.7, 0.34, "Select your weapons", true )
	--create an OK button to allow the user to confirm their seclections, and attach it to the confirmSelection funnction		--create an OK button to allow the user to confirm their seclections, and attach it to the confirmSelection funnction
	spawnScreenOKButton = guiCreateButton ( 0.4, 0.85, 0.20, 0.15, "OK", true, spawnScreenMenu )		spawnScreenOKButton = guiCreateButton ( 0.4, 0.85, 0.20, 0.15, "OK", true, spawnScreenMenu )
	--ensure the user doesnt move or resize our spawnscreen.		--ensure the user doesnt move or resize our spawnscreen.
	guiWindowSetMovable ( spawnScreenMenu, false )		guiWindowSetMovable ( spawnScreenMenu, false )
	guiWindowSetSizable ( spawnScreenMenu, false )		guiWindowSetSizable ( spawnScreenMenu, false )
	--create our gridlist, which fills up most of the window.		--create our gridlist, which fills up most of the window.
	spawnScreenGridList = guiCreateGridList ( 0, 0.1, 1, 0.9, true, spawnScreenMenu )		spawnScreenGridList = guiCreateGridList ( 0, 0.1, 1, 0.9, true, spawnScreenMenu )
	--Since we have 3 sets of weapons ~~to select~~, we create ~~3 new columns,~~ one for ~~handgun, uzi~~ and ~~heavy weapon.~~		guiGridListSetSelectionMode ( spawnScreenGridList, 2 )--ensure the selection mode is one per column
	guiGridListAddColumn ( spawnScreenGridList, "~~Handgun~~", 0.3 )		--Since we have 2 sets of weapons, create one for shotguns and one for machine guns
	guiGridListAddColumn ( spawnScreenGridList, "~~Uzi~~", 0.3 )		guiGridListAddColumn ( spawnScreenGridList, "Shotguns", 0.3 )
	-- next, we loop through our handguns table to add handgun items to the gridlist		guiGridListAddColumn ( spawnScreenGridList, "Machine guns", 0.3 )
	for key,weaponName in pairs(~~handguns~~) do		-- next, we loop through our handguns table to add handgun items to the gridlist
	--add a new row to our gridlist each time		for key,weaponName in pairs(shotguns) do
	local row = guiGridListAddRow ( spawnScreenGridList ) --get our new row		--add a new row to our gridlist each time
	--next, we set that rows text to the weapon name. Column is 1 since the "~~Handgun~~" column was created first.		local row = guiGridListAddRow ( spawnScreenGridList ) --get our new row
	guiGridListSetItemText ( spawnScreenGridList, row, 1, weaponName, false, false )		--next, we set that rows text to the weapon name. Column is 1 since the "Shotguns" column was created first.
	end		guiGridListSetItemText ( spawnScreenGridList, row, 1, weaponName, false, false )
	--we repeat the process for other weapon lists, changing the column number		end
	row = 0		--we repeat the process for other weapon lists, changing the column number
	for key,weaponName in pairs(~~uzis~~) do		row = 0
	--we dont bother creating new rows, since we already have done that		for key,weaponName in pairs(machineGun) do
	--next, we set that rows text to the weapon name. Column is 2 since the "~~Uzis~~" column was created second.		--we dont bother creating new rows, since we already have done that
	guiGridListSetItemText ( spawnScreenGridList, row, 2, weaponName, false, false )		--next, we set that rows text to the weapon name. Column is 2 since the "Machine guns" column was created second.
	row = row + 1 --increase the row number		guiGridListSetItemText ( spawnScreenGridList, row, 2, weaponName, false, false )
	end		row = row + 1 --increase the row number
			end
	end		end
	addEventHandler ( "onClientResourceStart", getRootElement(), setupWeaponSelection )		addEventHandler ( "onClientResourceStart", getRootElement(), setupWeaponSelection )

← Older revision		Revision as of 14:06, 20 May 2018
Line 88:		Line 88:
	==See Also==		==See Also==
	{{GUI functions}}		{{GUI functions}}
			{{GUI_events}}