GetThisResource: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This function retrieves the resource from which the function call was made. | ||
==Syntax== | ==Syntax== | ||
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
getThisResource ( ) | resource getThisResource ( ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns | Returns a resource object (or pointer?). | ||
==Example== | ==Example== | ||
<!-- Explain what the example is in a single sentance --> | <!-- Explain what the example is in a single sentance --> | ||
This example | This example performs a check to see if the resource started is the right one: | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | addEventHandler("onResourceStart", getRootElement(), "onStartInScoresResource") | ||
function onStartInScoresResource(resource) | |||
-- | local thisResource = getThisResource() -- get the resource that this script is a part of | ||
if (resource == thisResource) then -- make sure the resource that started is the one this script is a part of | |||
-- Note: without this check, the operations below would execute whenever ANY resource is loaded | |||
-- perform some operations this script will be used for, in this case keeping track of player scores and money: | |||
local players = getElementsByType("player") | |||
for playerKey, playerValue in players do | |||
setPlayerMoney(playerValue, 500) | |||
setElementData(playerValue, "score", 0) | |||
end | |||
end | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | ||
{{ | {{Resource_functions}} | ||
[[Category: | [[Category:Needs_Checking]] | ||
Revision as of 02:19, 12 April 2007
This function retrieves the resource from which the function call was made.
Syntax
resource getThisResource ( )
Returns
Returns a resource object (or pointer?).
Example
This example performs a check to see if the resource started is the right one:
addEventHandler("onResourceStart", getRootElement(), "onStartInScoresResource")
function onStartInScoresResource(resource)
local thisResource = getThisResource() -- get the resource that this script is a part of
if (resource == thisResource) then -- make sure the resource that started is the one this script is a part of
-- Note: without this check, the operations below would execute whenever ANY resource is loaded
-- perform some operations this script will be used for, in this case keeping track of player scores and money:
local players = getElementsByType("player")
for playerKey, playerValue in players do
setPlayerMoney(playerValue, 500)
setElementData(playerValue, "score", 0)
end
end
end