GetResourceGUIElement: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these.<!-- You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element). ---- Confirm please? ---- --> | |||
==Syntax== | |||
<syntaxhighlight lang="lua">element getResourceGUIElement ( [resource theResource=getThisResource()] )</syntaxhighlight> | |||
== | ===Optional Arguments=== | ||
{{OptionalArg}} | |||
*'''theResource:''' the resource whose GUI element we are getting. If not specified, assumes the current resource. (the resource returned from [[getThisResource]]) | |||
===Returns=== | ===Returns=== | ||
Returns the root GUI element that contains all the other GUI elements | Returns the root GUI element that contains all the other GUI elements. | ||
==Example== | ==Example== | ||
Revision as of 13:57, 9 August 2009
This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these.
Syntax
element getResourceGUIElement ( [resource theResource=getThisResource()] )
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- theResource: the resource whose GUI element we are getting. If not specified, assumes the current resource. (the resource returned from getThisResource)
Returns
Returns the root GUI element that contains all the other GUI elements.
Example
Click to collapse [-]
Client-- Add example