GuiGetProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Client function}} __NOTOC__ This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://www.c...)
 
mNo edit summary
Line 28: Line 28:
)
)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{GUI functions}}

Revision as of 19:01, 18 January 2008

This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the CEGUI properties wiki page.

Syntax

table guiGetProperties ( element guiElement )

Required Arguments

  • guiElement: the GUI element you wish to get the properties of.

Returns

If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties. If the function fails, it returns false.

Example

The following example code will create a button and lists its properties in the console if the /btn command is entered. 

addCommandHandler("btn",
    function()
        local btn = guiCreateButton(20, 200, 150, 30, "Test", false)
        local props = guiGetProperties(btn)
        for propName,propVal in pairs(props) do
            outputConsole(propName .. " = " .. propVal)
        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

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGetProperties?oldid=15098"