GuiGridListClear - Revision history

Tails: /* Example */

2022-12-22T17:47:52Z

Example

← Older revision		Revision as of 17:47, 22 December 2022
Line 16:		Line 16:

	==Example==		==Example==
	~~Example 1:~~ This creates a player list and then clears it when a button is clicked:		This creates a player list and then clears it when a button is clicked:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- create the grid list		-- create the grid list

Tails: /* Example */

2022-12-22T17:47:32Z

Example

← Older revision		Revision as of 17:47, 22 December 2022
Line 16:		Line 16:

	==Example==		==Example==
	This ~~example~~ creates a ~~grid~~ list~~, puts 2 items in to display the text "Hello" and "world"~~ and clears ~~the grid list after 5 seconds.~~		Example 1: This creates a player list and then clears it when a button is clicked:
	<syntaxhighlight lang="lua">~~function clientsideResourceStart ()~~		<syntaxhighlight lang="lua">
	-- ~~Create~~ the grid list ~~element~~		-- create the grid list
	local ~~testList~~ = guiCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )		local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
	~~-- Create a column in the list and add 2 rows displaying "Hello" text and "world" text~~		guiGridListAddColumn(playerList, "#", 0.15)
	~~local column =~~ guiGridListAddColumn( ~~testList~~, "~~test~~", 0.85 )		guiGridListAddColumn(playerList, "Player", 0.75)
	~~guiGridListSetItemText~~ ( ~~testList, guiGridListAddRow ( testList ), column~~, "~~Hello~~", ~~false, false~~ )
	~~guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World", false, false )~~		-- fill the grid list with player names
	-- ~~Set a timer to call the guiGridListClear function to clear~~ the grid list ~~items~~ in ~~5 seconds~~		for index, player in ipairs(getElementsByType("player")) do
	~~setTimer~~ ( ~~guiGridListClear~~, ~~5000~~, ~~1, testList~~ )		guiGridListAddRow(playerList, index, getPlayerName(player))
	end		end
	addEventHandler ( "~~onClientResourceStart~~", ~~resourceRoot~~, ~~clientsideResourceStart~~ )</syntaxhighlight>
			-- create a button to clear the grid list
			local clearButton = guiCreateButton(0.80, 0.30, 0.15, 0.05, "Clear list", true)

			-- when the button is clicked, clear the grid list
			addEventHandler("onClientGUIClick", clearButton, function()
			guiGridListClear(playerList)
			end)
			</syntaxhighlight>

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

StrixG: OOP syntax

2018-11-07T21:08:01Z

OOP syntax

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

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

LordHenry: /* See Also */

2018-05-20T14:07:51Z

Ccw at 16:30, 11 February 2015

2015-02-11T16:30:02Z

← Older revision		Revision as of 16:30, 11 February 2015
Line 26:		Line 26:
	setTimer ( guiGridListClear, 5000, 1, testList )		setTimer ( guiGridListClear, 5000, 1, testList )
	end		end
	addEventHandler ( "onClientResourceStart", ~~getRootElement()~~, clientsideResourceStart )</syntaxhighlight>		addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )</syntaxhighlight>

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

Ransom at 07:40, 9 October 2007

2007-10-09T07:40:56Z

← Older revision		Revision as of 07:40, 9 October 2007
Line 17:		Line 17:
	This example creates a grid list, puts 2 items in to display the text "Hello" and "world" and clears the grid list after 5 seconds.		This example creates a grid list, puts 2 items in to display the text "Hello" and "world" and clears the grid list after 5 seconds.
	<syntaxhighlight lang="lua">function clientsideResourceStart ()		<syntaxhighlight lang="lua">function clientsideResourceStart ()
	local testList = guiCreateGridList ( 0.45, 0.45, 0.15, 0.15, true ) ~~-- Create the grid list element~~		-- Create the grid list element
	~~local column = guiGridListAddColumn( testList, "test", 0.85 )~~ -- Create a column in the list and add 2 rows displaying "Hello" text and "world" text		local testList = guiCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )
			-- Create a column in the list and add 2 rows displaying "Hello" text and "world" text
			local column = guiGridListAddColumn( testList, "test", 0.85 )
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello", false, false )		guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello", false, false )
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World", false, false )		guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World", false, false )
	~~setTimer ( guiGridListClear, 5000, 1, testList )~~ -- Set a timer to call the guiGridListClear function to clear the grid list items in 5 seconds		-- Set a timer to call the guiGridListClear function to clear the grid list items in 5 seconds
			setTimer ( guiGridListClear, 5000, 1, testList )
	end		end
	addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )</syntaxhighlight>		addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )</syntaxhighlight>

Ransom: /* Example */

2007-10-08T05:06:30Z

Example

← Older revision		Revision as of 05:06, 8 October 2007
Line 15:		Line 15:

	==Example==		==Example==
	This example creates a grid list, puts ~~an item with~~ the text "Hello world" ~~in it~~ and clears the grid list after 5 seconds.		This example creates a grid list, puts 2 items in to display the text "Hello" and "world" and clears the grid list after 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">function clientsideResourceStart ()
	~~-- Create the grid list element~~		local testList = guiCreateGridList ( 0.45, 0.45, 0.15, 0.15, true ) -- Create the grid list element
	local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )		local column = guiGridListAddColumn( testList, "test", 0.85 ) -- Create a column in the list and add 2 rows displaying "Hello" text and "world" text
	-- Create a column in the list and add ~~a row with~~ "Hello world" text		guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello", false, false )
	~~local column = guiGridListAddColumn~~( testList, "~~test~~", ~~0.85~~ )		guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World", false, false )
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "~~Hello~~ World", false, false )		setTimer ( guiGridListClear, 5000, 1, testList ) -- Set a timer to call the guiGridListClear function to clear the grid list items in 5 seconds
	-- Set a timer to clear the grid list in 5 seconds		end
	~~setTimer~~ ( ~~guiGridListClear~~, ~~5000~~, ~~1, testList~~ )		addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )</syntaxhighlight>
	</syntaxhighlight>

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

Arc at 15:13, 18 August 2007

2007-08-18T15:13:55Z

← Older revision		Revision as of 15:13, 18 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Client function}}
	This function clears ~~out~~ all the data from a ~~GUI~~ grid list ~~element~~		__NOTOC__
			This function clears all the data from a grid list.

	==Syntax==		==Syntax==
Line 11:		Line 12:

	===Returns===		===Returns===
	Returns ''true'' if the grid list element is valid and it has been cleared successfully, ''false'' otherwise.		Returns ''true'' if the grid list element is valid and has been cleared successfully, ''false'' otherwise.

	==Example==		==Example==
	This example creates a grid list, puts a "Hello world" ~~text~~ in and clears ~~it in~~ 5 seconds		This example creates a grid list, puts an item with the text "Hello world" in it and clears the grid list after 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~function test ()~~		-- Create the grid list element
	--Create the grid list element		local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )
	local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )		-- Create a column in the list and add a row with "Hello world" text
	--Create a column in the list and add a row with "Hello world" text		local column = guiGridListAddColumn( testList, "test", 0.85 )
	local column = guiGridListAddColumn( testList, "test", 0.85 )		guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )		-- Set a timer to clear the grid list in 5 seconds
	--Set a timer to clear the grid list in 5 seconds		setTimer ( guiGridListClear, 5000, 1, testList )
	setTimer ( guiGridListClear, 5000, 1, testList )
	~~end~~
	</syntaxhighlight>		</syntaxhighlight>

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

Lil Toady at 19:59, 30 July 2007

2007-07-30T19:59:09Z

← Older revision		Revision as of 19:59, 30 July 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~		This function clears out all the data from a GUI grid list element
	This ~~fake~~ function ~~is for use with blah & blah and does blahblahblabhalbhl~~

	==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">
	bool guiGridListClear ( element gridList )		bool guiGridListClear ( element gridList )
Line 10:		Line 8:

	===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 element to be cleared
	*'''~~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 ''true'' if the grid list element is valid and it has been cleared successfully, ''false'' otherwise.
	Returns ''true'' if ~~blah~~, ''false'' otherwise.

	==Example==		==Example==
	~~<!-- Explain what the~~ example ~~is in~~ a ~~single sentance -->~~		This example creates a grid list, puts a "Hello world" text in and clears it in 5 seconds
	~~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 test ()
	~~blabhalbalhb~~ --~~abababa~~		--Create the grid list element
	--~~This line does this...~~		local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )
	~~mooo~~		--Create a column in the list and add a row with "Hello world" text
			local column = guiGridListAddColumn( testList, "test", 0.85 )
			guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )
			--Set a timer to clear the grid list in 5 seconds
			setTimer ( guiGridListClear, 5000, 1, testList )
			end
	</syntaxhighlight>		</syntaxhighlight>

	==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]]~~

Cray: /* Syntax */

2007-06-16T10:59:51Z

Syntax

← Older revision		Revision as of 10:59, 16 June 2007
Line 6:		Line 6:
	<!-- 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~~ )		bool guiGridListClear ( element gridList )
	</syntaxhighlight>		</syntaxhighlight>

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