GuiGetProperty: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function gets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) CEGUI properties wiki page].
This function gets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the [http://static.cegui.org.uk/static/WindowsLookProperties.html CEGUI properties page].


==Syntax==
==Syntax==
Line 7: Line 7:
string guiGetProperty ( element guiElement, string property )
string guiGetProperty ( element guiElement, string property )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:getProperty||guiSetProperty}}


===Required Arguments===
===Required Arguments===
Line 18: Line 19:
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
addEventHandler("onClientResourceStart", getResourceRootElement(),
     function()
     function()
         button = guiCreateButton(20, 200, 150, 30, "Test", false)
         button = guiCreateButton(20, 200, 150, 30, "Test", false)
Line 38: Line 39:
==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
{{GUI_events}}

Latest revision as of 17:17, 21 November 2018

This function gets 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

string guiGetProperty ( element guiElement, string property )

OOP Syntax Help! I don't understand this!

Method: GuiElement:getProperty(...)
Counterpart: guiSetProperty


Required Arguments

  • guiElement: the GUI element you wish to get a property of.
  • property: the name of of property you want the value of.

Returns

If the function succeeds, it returns a string with the value of the property. If it fails, it returns false.

Example

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

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

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

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/GuiGetProperty?oldid=60850"