GetThisResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Noted the secret root variable)
Line 5: Line 5:


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.
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.
'''Note:''' There is a secret variable to accomplish this. Using '''root''' will have the same effect as using this function.


==Syntax==  
==Syntax==  

Revision as of 21:38, 19 February 2011

Dialog-information.png 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.

Note: There is a secret variable to accomplish this. Using root will have the same effect as using this function.

Syntax

resource getThisResource ( )

Returns

Returns the resource in which the current script is.

Example

Click to collapse [-]
Server

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

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