DgsSetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(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 )...")
 
m (DGS OOP Syntax changing)
 
(5 intermediate revisions by 3 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxGUISetText ( element guiElement, string text )
bool dgsSetText ( element DGS element, string text )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:setText|
    Variable = text|
    Counterpart = dgsGetText
}}


===Required Arguments===
===Required Arguments===
Line 20: Line 25:
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 33:
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}}
 
==<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}}

Latest revision as of 21:24, 3 May 2021

This function sets the text of a DGS element.

Syntax

bool dgsSetText ( element DGS element, string text )

DGS OOP Syntax Help! I don't understand this!

Method: DGSElement:setText(...)
Variable: .text
Counterpart: dgsGetText

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. 

DGS = exports.dgs
-- create an empty label
local myLabel = DGS:dgsCreateLabel  ( 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:dgsSetText ( 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:dgsSetText, 5000, 1, myLabel, "" )
	end
end
addEventHandler ( "onClientDgsDxMouseClick", root, addLabelOnClick )

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetText?oldid=71002"