GuiSetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
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}}

Revision as of 02:59, 9 August 2017

This function sets the text of a DGS element.

Syntax

bool dgsDxGUISetText ( element guiElement, string text )

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: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 )

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiSetText?oldid=51808"