GuiGetText - Revision history

Pawelo: Remove redundant comment

2021-08-05T08:06:55Z

Remove redundant comment

← Older revision		Revision as of 08:06, 5 August 2021
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 is used to get the text of GUI elements like edit boxes, labels, buttons etc.		This function is used to get the text of GUI elements like edit boxes, labels, buttons etc.

LordHenry: /* See Also */

2018-11-21T17:18:41Z

Qaisjp: fix alias

2016-01-02T02:36:29Z

fix alias

← Older revision		Revision as of 02:36, 2 January 2016
Line 9:		Line 9:
	string guiGetText ( element guiElement )		string guiGetText ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[GUI ~~Widgets~~\|GuiElement]]:getText\|text\|guiSetText}}		{{OOP\|\|[[GUI widgets\|GuiElement]]:getText\|text\|guiSetText}}

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

Qaisjp: add alias

2016-01-02T02:36:06Z

add alias

← Older revision		Revision as of 02:36, 2 January 2016
Line 9:		Line 9:
	string guiGetText ( element guiElement )		string guiGetText ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[GuiElement]]:getText\|text\|guiSetText}}		{{OOP\|\|[[GUI Widgets\|GuiElement]]:getText\|text\|guiSetText}}

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

Qaisjp: fix syntax

2016-01-02T02:35:44Z

fix syntax

← Older revision		Revision as of 02:35, 2 January 2016
Line 9:		Line 9:
	string guiGetText ( element guiElement )		string guiGetText ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[~~Element\|guiElement~~]]:getText\|text\|guiSetText}}		{{OOP\|\|[[GuiElement]]:getText\|text\|guiSetText}}

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

Gothemsh: Added OOP Syntax

2015-12-29T22:55:57Z

Added OOP Syntax

← Older revision		Revision as of 22:55, 29 December 2015
Line 8:		Line 8:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string guiGetText ( element guiElement )		string guiGetText ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[Element\|guiElement]]:getText\|text\|guiSetText}}

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

IJs at 12:21, 28 November 2007

2007-11-28T12:21:45Z

← Older revision		Revision as of 12:21, 28 November 2007
Line 24:		Line 24:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- We create a dummy gui label to get text of		-- We create a dummy gui label to get text of
	local ~~dummyGuiElement~~ = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )		local dummyGUIElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
	-- Output the text of the label to chat box		-- Output the text of the label to chat box
	outputChatBox ( "Text in the GUI label: " .. guiGetText ( ~~dummyGuiElement~~ ) )		outputChatBox ( "Text in the GUI label: " .. guiGetText ( dummyGUIElement ) )
	</syntaxhighlight>		</syntaxhighlight>

Arc at 15:05, 18 August 2007

2007-08-18T15:05:49Z

← Older revision		Revision as of 15:05, 18 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Client function}}
			__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 function is used to get text ~~from~~ GUI elements like edit boxes, labels, buttons, etc.		This function is used to get the text of GUI elements like edit boxes, labels, buttons etc.

	==Syntax==		==Syntax==
Line 22:		Line 23:
	<!-- 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 -->		<!-- 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">
	~~function test ()~~		-- We create a dummy gui label to get text of
	--we create a dummy gui label to get text of		local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
	local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )		-- Output the text of the label to chat box
	--~~output~~ the text of the label to chat box		outputChatBox ( "Text in the GUI label: " .. guiGetText ( dummyGuiElement ) )
	outputChatBox ( "Text in the GUI label: "..guiGetText ( dummyGuiElement ) )
	~~end~~
	</syntaxhighlight>		</syntaxhighlight>

Lil Toady at 14:09, 30 July 2007

2007-07-30T14:09:33Z

← Older revision		Revision as of 14:09, 30 July 2007
Line 32:		Line 32:
	==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 -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{~~FunctionArea_functions~~}}		{{GUI_functions}}
	~~[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.~~
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Lil Toady at 14:04, 30 July 2007

2007-07-30T14:04:55Z

← Older revision		Revision as of 14:04, 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 -->		<!-- 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 is used to get text from GUI elements like edit boxes, labels, buttons, etc.

	==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">
	string guiGetText ( element ~~guielement~~ )		string guiGetText ( element guiElement )
	</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 -->		<!-- 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 -->
	*'''~~argumentName~~:''' ~~description~~		*'''guiElement:''' element you wish to get text of.

	~~<!-- 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 -->		<!-- 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 blah~~, ''false~~'' otherwise~~.		Returns a string containing the requested element's text, or false if the gui element passed to the function is invalid.

	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	This example ~~does..~~.		This example gets the text of a pre-made gui element and outputs it to chat box.
	<!-- 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 -->		<!-- 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~~		--we create a dummy gui label to get text of
	~~--This line does this.~~..		local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
	~~mooo~~		--output the text of the label to chat box
			outputChatBox ( "Text in the GUI label: "..guiGetText ( dummyGuiElement ) )
			end
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 17:18, 21 November 2018
Line 33:		Line 33:
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- 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}}
			{{GUI_events}}