GetResourceRootElement: Difference between revisions
No edit summary |
No edit summary Tag: Undo |
||
| (9 intermediate revisions by 7 users not shown) | |||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). 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). | This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). 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). | ||
Note: every resource has a [[Predefined_variables_list|predefined global variable]] called ''resourceRoot'' whose value is the root element of that resource. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
element getResourceRootElement ( [resource theResource=getThisResource()] ) | element getResourceRootElement ( [resource theResource=getThisResource()] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[resource]]:getRootElement|rootElement}} | |||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''theResource:''' the resource whose root element we are getting. If not specified, assumes the current resource (the resource returned from [[getThisResource]] | *'''theResource:''' the resource whose root element we are getting. If not specified, assumes the current resource. (the resource returned from [[getThisResource]]) | ||
===Returns=== | ===Returns=== | ||
| Line 16: | Line 18: | ||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | |||
This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the ''current'' resource is started rather than when ''any'' resource is started, thereby reducing unnecessary overhead. | This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the ''current'' resource is started rather than when ''any'' resource is started, thereby reducing unnecessary overhead. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- get the root element of this resource (the resource that the script is a part of) | -- get the root element of this resource (the resource that the script is a part of) | ||
resourceRoot = getResourceRootElement( | resourceRoot = getResourceRootElement() | ||
-- create a function to handle the onResourceStart event | -- create a function to handle the onResourceStart event | ||
| Line 30: | Line 33: | ||
addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart) | addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Resource_functions}} | {{Resource_functions}} | ||
Latest revision as of 18:38, 17 December 2023
This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). 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).
Note: every resource has a predefined global variable called resourceRoot whose value is the root element of that resource.
Syntax
element getResourceRootElement ( [resource theResource=getThisResource()] )
OOP Syntax Help! I don't understand this!
- Method: resource:getRootElement(...)
- Variable: .rootElement
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 root element we are getting. If not specified, assumes the current resource. (the resource returned from getThisResource)
Returns
Returns an element representing the resource's root, false if the specified resource doesn't exist.
Example
This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the current resource is started rather than when any resource is started, thereby reducing unnecessary overhead.
-- get the root element of this resource (the resource that the script is a part of)
resourceRoot = getResourceRootElement()
-- create a function to handle the onResourceStart event
function onCurrentResourceStart(theResource)
local resourceName = getResourceName(theResource)
outputChatBox("Hello and welcome to " .. resourceName .. "!")
end
-- add the event handler
addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart)
See Also
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo