GuiGridListGetSelectedItem - Revision history

Tracer: Changed syntax

2024-06-19T19:05:16Z

Changed syntax

← Older revision		Revision as of 19:05, 19 June 2024
Line 16:		Line 16:

	==Example==		==Example==
			<section class="client" name="Client" show="true">
	This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box.		This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~createPlayerList~~ ()		addEventHandler('onClientResourceStart', resourceRoot, function()
	~~-- Create the grid list~~		local playerList = guiCreateGridList(0.8, 0.1, 0.15, 0.6, true)
	playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, 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
	for id, playeritem in ipairs(getElementsByType("player")) do		-- If the column has been created, fill it with players
	local row = guiGridListAddRow ( playerList )		if not column then return end
	guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
	end		for id, playeritem in ipairs(getElementsByType('player')) do
	~~addEventHandler ( "onClientGUIClick", playerList, click )~~		local row = guiGridListAddRow ( playerList )
	~~end~~		guiGridListSetItemText(playerList, row, column, getPlayerName(playeritem), false, false)
	~~end~~		end
	~~addEventHandler ( "onClientResourceStart", resourceRoot, createPlayerList )~~

	~~function click~~ ( ~~button~~, ~~state~~, ~~sx, sy, x, y, z, elem, gui~~ )		addEventHandler('onClientGUIClick', playerList, function()
	~~-- if state is down~~ ( ~~not to trigger the function twice on mouse button up/down~~)~~, clicked gui and the element is our player list~~		local row, column = guiGridListGetSelectedItem(playerList)
	if ( ( ~~state == "down" ) and ( gui == true ) and ( source ==~~ playerList ~~) ) then~~		outputChatBox(guiGridListGetItemText(playerList, row, column))
	~~-- get the player name from the selected~~ row, ~~first~~ column		end)
	~~local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList~~ )~~, 1~~ )
	~~outputChatBox ( playerName )~~ ~~-- output it to chat box~~
	end
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>

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

Olez14 at 16:50, 11 June 2020

2020-06-11T16:50:04Z

← Older revision		Revision as of 16:50, 11 June 2020
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function returns the row and column indexes of the selected item in a grid list. First row and column is (0, 0).		This function returns the row and column indexes of the selected item in a grid list. First selected row and column is (0, 0).

	==Syntax==		==Syntax==

Olez14: Helpful note

2020-06-11T16:49:12Z

Helpful note

← Older revision		Revision as of 16:49, 11 June 2020
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function returns the row and column indexes of the selected item in a grid list.		This function returns the row and column indexes of the selected item in a grid list. First row and column is (0, 0).

	==Syntax==		==Syntax==

Dutchman101: typo fix

2019-09-02T04:15:42Z

typo fix

← Older revision		Revision as of 04:15, 2 September 2019
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function returns the row and ~~colum~~ indexes of the selected item in a grid list.		This function returns the row and column indexes of the selected item in a grid list.

	==Syntax==		==Syntax==

StrixG: OOP syntax

2018-11-07T21:16:21Z

OOP syntax

← Older revision		Revision as of 21:16, 7 November 2018
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int, int guiGridListGetSelectedItem ( element gridList )		int, int guiGridListGetSelectedItem ( element gridList )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[Element/GUI/Gridlist\|GuiGridList]]:getSelectedItem}}

	===Required Arguments===		===Required Arguments===

LordHenry: /* See Also */

2018-05-20T14:09:49Z

Ccw: /* Example */

2015-02-11T16:32:07Z

Example

← Older revision		Revision as of 16:32, 11 February 2015
Line 30:		Line 30:
	end		end
	end		end
	addEventHandler ( "onClientResourceStart", ~~getRootElement()~~, createPlayerList )		addEventHandler ( "onClientResourceStart", resourceRoot, createPlayerList )

	function click ( button, state, sx, sy, x, y, z, elem, gui )		function click ( button, state, sx, sy, x, y, z, elem, gui )

Jbeta: Fixed syntax

2007-11-01T21:49:15Z

Fixed syntax

← Older revision		Revision as of 21:49, 1 November 2007
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~		This function returns the row and colum indexes of the selected item in a grid list.
	This function returns the row ~~index~~ of the selected item in a grid list.

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int guiGridListGetSelectedItem ( element gridList )		int, int guiGridListGetSelectedItem ( element gridList )
	</syntaxhighlight>		</syntaxhighlight>

Line 14:		Line 12:

	===Returns===		===Returns===
	Returns the row ~~index~~ of the selected item if the specified grid list is valid and has a selected item, ''false'' otherwise.		Returns the row and column indexes of the selected item if the specified grid list is valid and has a selected item, (-1, -1) if no item is selected, ''false'' otherwise.

	==Example==		==Example==

Talidan at 12:00, 22 October 2007

2007-10-22T12:00:52Z

← Older revision		Revision as of 12:00, 22 October 2007
Line 29:		Line 29:
	guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )		guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
	end		end
	addEventHandler ( "~~onClientClick~~", playerList, click )		addEventHandler ( "onClientGUIClick", playerList, click )
	end		end
	end		end
Line 45:		Line 45:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~
	{{GUI functions}}		{{GUI functions}}
	~~[[Category:Incomplete]]~~

Arc at 16:38, 18 August 2007

2007-08-18T16:38:26Z

← Older revision		Revision as of 16:38, 18 August 2007
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This ~~fake~~ function ~~is for use with blah & blah and does blahblahblabhalbhl~~		This function returns the row index of the selected item in a grid list.

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~returnType functionName~~ ( ~~arguments~~ )		int guiGridListGetSelectedItem ( element gridList )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~		*'''gridList:''' the grid list you want to know the selected row index of
	*'''~~argumentName~~:''' ~~description~~

	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' description
	*'''argumentName3:''' description

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~		Returns the row index of the selected item if the specified grid list is valid and has a selected item, ''false'' otherwise.
	Returns ~~''true''~~ if ~~blah~~, ''false'' otherwise.

	==Example==		==Example==
	~~<!-- Explain what~~ the ~~example is in a single sentance -->~~		This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box.
	~~This example does.~~..
	~~<!-- Add~~ the ~~code below~~, ~~an emphasis should~~ be ~~on making it clear, not optimized~~. ~~You could provide two versions if you wish, one clear and well commented, the other optimized -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does~~...		function createPlayerList ()
	~~blabhalbalhb~~ --~~abababa~~		-- Create the grid list
	--~~This line does this...~~		playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
	~~mooo~~		-- Create a players column in the list
			local column = guiGridListAddColumn( playerList, "Player", 0.85 )
			if ( column ) then -- If the column has been created, fill it with players
			for id, playeritem in ipairs(getElementsByType("player")) do
			local row = guiGridListAddRow ( playerList )
			guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
			end
			addEventHandler ( "onClientClick", playerList, click )
			end
			end
			addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )

			function click ( button, state, sx, sy, x, y, z, elem, gui )
			-- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
			if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
			-- get the player name from the selected row, first column
			local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
			outputChatBox ( playerName ) -- output it to chat box
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

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