GetResourceRootElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element getResourceRootElement ( [resource theResource] )  
element getResourceRootElement ( [resource theResource=getThisResource()] )  
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Optional Arguments===
*'''theResource:''' the resource whose root element we are getting. If no specified, assumes ''this'' resource.
{{OptionalArg}}
*'''theResource:''' the resource whose root element we are getting. If not specified, assumes the current resource (the resource returned from [[getThisResource]].


===Returns===
===Returns===

Revision as of 20:57, 12 December 2007

This function retrieves a resource's root element.

Syntax

element getResourceRootElement ( [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 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(getThisResource())

-- 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