GuiSetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 22: Line 22:


==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
--retreive 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>


Revision as of 14:32, 1 August 2007

This function is for setting text of a GUI element

Syntax

bool guiSetText ( element, text )

Required Arguments

  • argumentName: description

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • argumentName2: description
  • argumentName3: description

Returns

Returns true if blah, 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
		--retreive 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

-- leave this unless you complete the function

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