GetThisResource: Difference between revisions
Jump to navigation
Jump to search
m (eh wrong one heh) |
|||
| Line 15: | Line 15: | ||
==Example== | ==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. | 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(getThisResource()) | ||
-- create a function to handle the onResourceStart event | -- create a function to handle the onResourceStart event | ||
| Line 30: | Line 29: | ||
addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart) | addEventHandler("onResourceStart", resourceRoot, onCurrentResourceStart) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Resource_functions}} | {{Resource_functions}} | ||
Revision as of 21:26, 11 June 2011
|
This article needs checking. |
Reason(s): Example lacks this function? |
This function retrieves the resource from which the function call was made.
Note: every resource has a predefined 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
- 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