GuiSetText - Revision history

LordHenry: /* See Also */

2018-11-21T17:20:51Z

StrixG at 15:46, 7 November 2018

2018-11-07T15:46:15Z

← Older revision		Revision as of 15:46, 7 November 2018
Line 7:		Line 7:
	bool guiSetText ( element guiElement, string text )		bool guiSetText ( element guiElement, string text )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|GuiElement:setText\|text\|guiGetText}}		{{OOP\|\|[[GUI widgets\|GuiElement]]:setText\|text\|guiGetText}}

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

StrixG: OOP syntax

2018-11-07T15:32:28Z

OOP syntax

← Older revision		Revision as of 15:32, 7 November 2018
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool guiSetText ( element guiElement, string text )		bool guiSetText ( element guiElement, string text )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|GuiElement:setText\|text\|guiGetText}}

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

Thisdp: Undo revision 51808 by Thisdp (talk)

2017-08-09T03:04:52Z

Undo revision 51808 by Thisdp (talk)

← Older revision		Revision as of 03:04, 9 August 2017
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function sets the text of a ~~DGS~~ element.		This function sets the text of a GUI element.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~dgsDxGUISetText~~ ( element guiElement, string text )		bool guiSetText ( element guiElement, string text )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' The ~~DGS~~ element you wish to change the text of		*'''guiElement:''' The GUI element you wish to change the text of
	*'''text:''' The new text		*'''text:''' The new text

	===Returns===		===Returns===
	Returns ''true'' if text has been successfully set on the ~~dgs~~ element, ''false'' otherwise.		Returns ''true'' if text has been successfully set on the gui element, ''false'' otherwise.

	==Example==		==Example==
	This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.		This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~DGS = exports.dgs~~
	-- create an empty label		-- create an empty label
	local myLabel = ~~DGS:dgsDxCreateLabel~~ ( 0, 0, 1, 1, "", true )		local myLabel = guiCreateLabel ( 0, 0, 1, 1, "", true )

	function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )		function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
Line 26:		Line 25:
	if ( clickedElement ) then		if ( clickedElement ) then
	-- retrieve the element type		-- retrieve the element type
	local elementType = ~~DGS:dgsGetType~~ ( clickedElement )		local elementType = getElementType ( clickedElement )
	-- change the label text to that element type		-- change the label text to that element type
	~~DGS:dgsDxGUISetText~~ ( myLabel, elementType )		guiSetText ( myLabel, elementType )
	-- and place it in the position of where the element is		-- and place it in the position of where the element is
	~~DGS:dgsSetPosition~~ ( myLabel, absoluteX, absoluteY, true )		guiSetPosition ( myLabel, absoluteX, absoluteY, true )
	-- hide the text by passing an empty string 5 seconds later		-- hide the text by passing an empty string 5 seconds later
	setTimer ( ~~DGS:dgsDxGUISetText~~, 5000, 1, myLabel, "" )		setTimer ( guiSetText, 5000, 1, myLabel, "" )
	end		end
	end		end
	addEventHandler ( "~~onClientDgsDxMouseClick~~", getRootElement(), addLabelOnClick )		addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{~~DGSFUNCTIONS~~}}		{{GUI_functions}}

Thisdp at 02:59, 9 August 2017

2017-08-09T02:59:55Z

← Older revision		Revision as of 02:59, 9 August 2017
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function sets the text of a ~~GUI~~ element.		This function sets the text of a DGS element.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~guiSetText~~ ( element guiElement, string text )		bool dgsDxGUISetText ( element guiElement, string text )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' The ~~GUI~~ element you wish to change the text of		*'''guiElement:''' The DGS element you wish to change the text of
	*'''text:''' The new text		*'''text:''' The new text

	===Returns===		===Returns===
	Returns ''true'' if text has been successfully set on the ~~gui~~ element, ''false'' otherwise.		Returns ''true'' if text has been successfully set on the dgs element, ''false'' otherwise.

	==Example==		==Example==
	This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.		This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			DGS = exports.dgs
	-- create an empty label		-- create an empty label
	local myLabel = ~~guiCreateLabel~~ ( 0, 0, 1, 1, "", true )		local myLabel = DGS:dgsDxCreateLabel ( 0, 0, 1, 1, "", true )

	function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )		function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
Line 25:		Line 26:
	if ( clickedElement ) then		if ( clickedElement ) then
	-- retrieve the element type		-- retrieve the element type
	local elementType = ~~getElementType~~ ( clickedElement )		local elementType = DGS:dgsGetType ( clickedElement )
	-- change the label text to that element type		-- change the label text to that element type
	~~guiSetText~~ ( myLabel, elementType )		DGS:dgsDxGUISetText ( myLabel, elementType )
	-- and place it in the position of where the element is		-- and place it in the position of where the element is
	~~guiSetPosition~~ ( myLabel, absoluteX, absoluteY, true )		DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, true )
	-- hide the text by passing an empty string 5 seconds later		-- hide the text by passing an empty string 5 seconds later
	setTimer ( ~~guiSetText~~, 5000, 1, myLabel, "" )		setTimer ( DGS:dgsDxGUISetText, 5000, 1, myLabel, "" )
	end		end
	end		end
	addEventHandler ( "~~onClientClick~~", getRootElement(), addLabelOnClick )		addEventHandler ( "onClientDgsDxMouseClick", getRootElement(), addLabelOnClick )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{~~GUI_functions~~}}		{{DGSFUNCTIONS}}

Arc at 14:39, 17 August 2007

2007-08-17T14:39:52Z

← Older revision		Revision as of 14:39, 17 August 2007
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function ~~is for setting~~ text of a GUI element		This function sets the text of a GUI element.

	==Syntax==		==Syntax==
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''guiElement:''' The GUI element, the text of ~~you wish to set~~		*'''guiElement:''' The GUI element you wish to change the text of
	*'''text:''' The text		*'''text:''' The new text

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

Arc at 14:37, 17 August 2007

2007-08-17T14:37:09Z

← Older revision		Revision as of 14:37, 17 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Client function}}
			__NOTOC__
	This function is for setting text of a GUI element		This function is for setting text of a GUI element

Line 15:		Line 16:

	==Example==		==Example==
	This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.		This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--create an empty label		-- create an empty label
	local myLabel = guiCreateLabel ( 0, 0, 1, 1, "", true )		local myLabel = guiCreateLabel ( 0, 0, 1, 1, "", true )

	function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )		function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
	--if an element was clicked on screen		-- if an element was clicked on screen
	if ( clickedElement ) then		if ( clickedElement ) then
	--~~retreive~~ the element type		-- retrieve the element type
	local elementType = getElementType ( clickedElement )		local elementType = getElementType ( clickedElement )
	--change the label text to that element type		-- change the label text to that element type
	guiSetText ( myLabel, elementType )		guiSetText ( myLabel, elementType )
	--and place it in the position of where the element is		-- and place it in the position of where the element is
	guiSetPosition ( myLabel, absoluteX, absoluteY, true )		guiSetPosition ( myLabel, absoluteX, absoluteY, true )
	--hide the text by passing an empty string 5 seconds later		-- hide the text by passing an empty string 5 seconds later
	setTimer ( guiSetText, 5000, 1, myLabel, "" )		setTimer ( guiSetText, 5000, 1, myLabel, "" )
	end		end

Lil Toady at 17:24, 7 August 2007

2007-08-07T17:24:30Z

← Older revision		Revision as of 17:24, 7 August 2007
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool guiSetText ( element, text )		bool guiSetText ( element guiElement, string text )
	</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 -->~~		*'''guiElement:''' The GUI element, the text of you wish to set
	*'''~~argumentName~~:''' ~~description~~		*'''text:''' The text

	~~<!-- 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 text has been successfully set on the gui element, ''false'' otherwise.
	Returns ''true'' if ~~blah~~, ''false'' otherwise.

	==Example==		==Example==
Line 44:		Line 37:

	==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]] -- leave this unless you complete the function~~

Talidan at 14:32, 1 August 2007

2007-08-01T14:32:59Z

← Older revision		Revision as of 14:32, 1 August 2007
Line 22:		Line 22:

	==Example==		==Example==
	~~<!-- Explain what the~~ example ~~is in~~ a ~~single sentance -->~~		This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 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...~~		--create an empty label
	~~blabhalbalhb~~ --~~abababa~~		local myLabel = guiCreateLabel ( 0, 0, 1, 1, "", true )
	--~~This line does this...~~
	~~mooo~~		function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
			--if an element was clicked on screen
			if ( clickedElement ) then
			--retreive the element type
			local elementType = getElementType ( clickedElement )
			--change the label text to that element type
			guiSetText ( myLabel, elementType )
			--and place it in the position of where the element is
			guiSetPosition ( myLabel, absoluteX, absoluteY, true )
			--hide the text by passing an empty string 5 seconds later
			setTimer ( guiSetText, 5000, 1, myLabel, "" )
			end
			end
			addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )
	</syntaxhighlight>		</syntaxhighlight>

Talidan at 03:40, 21 December 2006

2006-12-21T03:40:11Z

← Older revision		Revision as of 03:40, 21 December 2006
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~guiSetSize~~ ( element ~~gui~~, ~~float width, float height, bool relative~~ )		bool guiSetText ( element, text )
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 17:20, 21 November 2018
Line 40:		Line 40:
	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
			{{GUI_events}}