GetThisResource: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
This function retrieves the resource from which the function call was made. | This function retrieves the resource from which the function call was made. | ||
Note: every resource has a global variable called "resource" that contains the resource pointer for that resource, in other words, the value that this function returns. | |||
==Syntax== | ==Syntax== |
Revision as of 22:21, 24 January 2008
This function retrieves the resource from which the function call was made.
Note: every resource has a global variable called "resource" that contains the resource pointer for that resource, in other words, the value that this function returns.
Syntax
resource getThisResource ( )
Returns
Returns the resource in which the current script is.
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
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo