GuiSetText: Difference between revisions

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


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


===Required Arguments===  
===Required Arguments===
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''guiElement:''' The GUI element you wish to change the text of
*'''argumentName:''' description
*'''text:''' The new text
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if text has been successfully set on the gui element, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
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 does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
-- create an empty label
blabhalbalhb --abababa
local myLabel = guiCreateLabel  ( 0, 0, 1, 1, "", true )
--This line does this...
 
mooo
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 )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function
{{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"