DgsSetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(DGS (OOP Syntax)/(Template Organization) Mission)
m (DGS OOP Syntax changing)
 
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===

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"