DgsSetText - Revision history

Lettify: DGS OOP Syntax changing

2021-05-03T21:24:33Z

DGS OOP Syntax changing

← Older revision		Revision as of 21:24, 3 May 2021
Line 7:		Line 7:
	bool dgsSetText ( element DGS element, string text )		bool dgsSetText ( element DGS element, string text )
	</syntaxhighlight>		</syntaxhighlight>
	{{DGS/OOP\|\|DGSElement:setText\|\|text\|dgsGetText}}		{{DGS/OOP\|
			Method = DGSElement:setText\|
			Variable = text\|
			Counterpart = dgsGetText
			}}

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

Lettify: DGS (OOP Syntax)/(Template Organization) Mission

2021-04-19T18:24:02Z

DGS (OOP Syntax)/(Template Organization) Mission

← Older revision		Revision as of 18:24, 19 April 2021
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dgsSetText ( element DGS element, string text )		bool dgsSetText ( element DGS element, string text )
	</syntaxhighlight>		</syntaxhighlight>
			{{DGS/OOP\|\|DGSElement:setText\|\|text\|dgsGetText}}

	===Required Arguments===		===Required Arguments===
Line 38:		Line 39:
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		=See Also=
	{{~~DGSFUNCTIONS~~}}
			==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
			{{DGS General Functions}}

			==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
			{{DGS Events/General}}

Thisdp at 15:44, 16 January 2018

2018-01-16T15:44:49Z

← Older revision		Revision as of 15:44, 16 January 2018
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~dgsDxGUISetText~~ ( element DGS element, string text )		bool dgsSetText ( element DGS element, string text )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: /* Example */

2018-01-16T15:40:24Z

Example

← Older revision		Revision as of 15:40, 16 January 2018
Line 20:		Line 20:
	DGS = exports.dgs		DGS = exports.dgs
	-- create an empty label		-- create an empty label
	local myLabel = DGS:~~dgsDxCreateLabel~~ ( 0, 0, 1, 1, "", true )		local myLabel = DGS:dgsCreateLabel ( 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 28:		Line 28:
	local elementType = DGS:dgsGetType ( clickedElement )		local elementType = DGS:dgsGetType ( clickedElement )
	-- change the label text to that element type		-- change the label text to that element type
	DGS:~~dgsDxGUISetText~~ ( myLabel, elementType )		DGS:dgsSetText ( 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 )		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 ( DGS:~~dgsDxGUISetText~~, 5000, 1, myLabel, "" )		setTimer ( DGS:dgsSetText, 5000, 1, myLabel, "" )
	end		end
	end		end
	addEventHandler ( "onClientDgsDxMouseClick", ~~getRootElement()~~, addLabelOnClick )		addEventHandler ( "onClientDgsDxMouseClick", root, addLabelOnClick )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{DGSFUNCTIONS}}		{{DGSFUNCTIONS}}

Thisdp: Thisdp moved page DgsDxGUISetText to DgsSetText

2018-01-16T15:32:28Z

Thisdp moved page DgsDxGUISetText to DgsSetText

← Older revision

Revision as of 15:32, 16 January 2018

Ahmed Ly: --Syntax

2017-08-25T15:11:11Z

--Syntax

← Older revision		Revision as of 15:11, 25 August 2017
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dgsDxGUISetText ( element ~~guiElement~~, string text )		bool dgsDxGUISetText ( element DGS element, string text )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: Created page with "{{Client function}} NOTOC This function sets the text of a DGS element. ==Syntax== bool dgsDxGUISetText ( element guiElement, string text )..."

2017-08-09T03:00:36Z

Created page with "{{Client function}} __NOTOC__ This function sets the text of a DGS element. ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxGUISetText ( element guiElement, string text )..."

New page

{{Client function}}
__NOTOC__
This function sets the text of a DGS element.

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

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

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

==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.
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- create an empty label
local myLabel = DGS:dgsDxCreateLabel ( 0, 0, 1, 1, "", true )

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

==See Also==
{{DGSFUNCTIONS}}