GuiSetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function sets the text of a DGS element.
This function sets the text of a GUI element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxGUISetText ( element guiElement, string text )
bool guiSetText ( element guiElement, string text )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:setText|text|guiGetText}}


===Required Arguments===
===Required Arguments===
*'''guiElement:''' The DGS element you wish to change the text of
*'''guiElement:''' The GUI 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 dgs element, ''false'' otherwise.
Returns ''true'' if text has been successfully set on the gui 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 = DGS:dgsDxCreateLabel ( 0, 0, 1, 1, "", true )
local myLabel = guiCreateLabel ( 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 26: Line 26:
if ( clickedElement ) then
if ( clickedElement ) then
-- retrieve the element type
-- retrieve the element type
local elementType = DGS:dgsGetType ( clickedElement )
local elementType = getElementType ( clickedElement )
-- change the label text to that element type
-- change the label text to that element type
DGS:dgsDxGUISetText ( myLabel, elementType )
guiSetText ( 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 )
guiSetPosition ( 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 ( guiSetText, 5000, 1, myLabel, "" )
end
end
end
end
addEventHandler ( "onClientDgsDxMouseClick", getRootElement(), addLabelOnClick )
addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 17:20, 21 November 2018

This function sets the text of a GUI element.

Syntax

bool guiSetText ( element guiElement, string text )

OOP Syntax Help! I don't understand this!

Method: GuiElement:setText(...)
Variable: .text
Counterpart: guiGetText


Required Arguments

  • guiElement: The GUI element you wish to change the text of
  • text: The new text

Returns

Returns true if text has been successfully set on the gui 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. 

-- create an empty label
local myLabel = guiCreateLabel  ( 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 = getElementType ( clickedElement )
		-- change the label text to that element type
		guiSetText ( myLabel, elementType )
		-- and place it in the position of where the element is
		guiSetPosition ( myLabel, absoluteX, absoluteY, true )
		-- hide the text by passing an empty string 5 seconds later
		setTimer ( guiSetText, 5000, 1, myLabel, "" )
	end
end
addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


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