GuiSetProperty

From Multi Theft Auto: Wiki
Revision as of 17:20, 21 November 2018 by LordHenry (talk | contribs) (→‎See Also)
Jump to navigation Jump to search

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.

Syntax

bool guiSetProperty ( element guiElement, string property, string value )

OOP Syntax Help! I don't understand this!

Method: GuiElement:setProperty(...)
Counterpart: guiGetProperty


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

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

Examples

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", getResourceRootElement(), 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 )

This example creates a button when the resource starts and defines its normal color to red and hover color to yellow.

function onStart()
  button = guiCreateButton (20, 200, 150, 30, "Test", false)
  guiSetProperty (button, "NormalTextColour", "FFFF0000") -- Color format: AARRGGBB
  guiSetProperty (button, "HoverTextColour", "FFFFFF00")
end
addEventHandler ("onClientResourceStart", getResourceRootElement(), onStart)

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