guiSetProperty | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

guiSetProperty

Client-side
Server-side
Shared

Pair: guiGetProperty

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function sets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the CEGUI properties page.

OOP Syntax Help! I don't understand this!

Syntax

bool guiSetProperty ( element guiElement, string property, string value )
Required Arguments
  • guiElement: the GUI element you wish to get a property of.
  • property: the name of of property you want the value of.
  • value: the new value for the property.

Returns

  • bool: value

If the function succeeds it returns true , if it fails it returns false .

Code Examples

shared

This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).

function onStart()
  button = guiCreateButton( 20, 200, 150, 30, "Test", false )
end
addEventHandler( "onClientResourceStart", resourceRoot, onStart )


function toogleButton()
  local currentState = guiGetProperty( button, "Disabled" )
  if currentState == "False" then
    guiSetProperty( button, "Disabled", "True" )
  else
    guiSetProperty( button, "Disabled", "False" )
  end
end
addCommandHandler( "togglebtn", toogleButton )

See Also

GUI Functions
GUI Elements
Reference