GetResourceRootElement

This function retrieves a resource's root element.

Syntax

element getResourceRootElement ( [resource theResource] ) 

Required Arguments

• theResource: the resource whose root element we are getting. If no specified, assumes this resource.

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

• abortRemoteRequest
• addResourceConfig
• addResourceMap
• call
• callRemote
• copyResource
• createResource
• deleteResource
• fetchRemote
• getRemoteRequestInfo
• getRemoteRequests
• getResourceACLRequests
• getResourceConfig
• getResourceDynamicElementRoot
• getResourceExportedFunctions
• getResourceFromName
• getResourceInfo
• getResourceLastStartTime
• getResourceLoadFailureReason
• getResourceLoadTime
• getResourceMapRootElement
• getResourceName
• getResourceOrganizationalPath
• getResourceRootElement
• getResources
• getResourceState
• getThisResource
• isResourceArchived
• isResourceProtected
• refreshResources
• removeResourceFile
• renameResource
• restartResource
• setResourceInfo
• startResource
• stopResource
• updateResourceACLRequest