GetResourceRootElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
{{Server function}}
__NOTOC__
This function retrieves a resource's root element.
This function retrieves a resource's root element.


Line 21: Line 22:
-- create a function to handle the onResourceStart event
-- create a function to handle the onResourceStart event
function onCurrentResourceStart(theResource)
function onCurrentResourceStart(theResource)
  local resourceName = getResourceName(theResource)
    local resourceName = getResourceName(theResource)
  outputChatBox("Hello and welcome to " .. resourceName .. "!")
    outputChatBox("Hello and welcome to " .. resourceName .. "!")
end
end



Revision as of 19:15, 17 August 2007

This function retrieves a resource's root element.

Syntax

element getResourceRootElement ( resource theResource ) 

Required Arguments

  • theResource: the resource whose root element we are getting.

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