Skip to content

guiSetText

Client-side

Pair: guiGetText

This function sets the text of a GUI element.

OOP Syntax Help! I don't understand this!

Syntax

bool guiSetText ( ​gui-element guiElement, ​string text )
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.

  • bool: result

Code Examples

client

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)
local timer
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
if (not isTimer(timer)) then
setTimer(guiSetText, 5000, 1, myLabel, "")
else
resetTimer(timer)
end
end
end
addEventHandler("onClientClick", root, addLabelOnClick)

See Also

GUI Functions