DgsSetText

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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