GetThisResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(it's a pointer to the resource, but we just say it returns a resource)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Needs_Checking|Does it return a pointer to a resource or a resource object?}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function retrieves the resource from which the function call was made.
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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
resource getThisResource ( )
resource getThisResource ( )
Line 11: Line 8:


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns the resource in which the current script is.
Returns a resource object (or pointer?).


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", getRootElement(), "onStartInScoresResource")
addEventHandler("onResourceStart", getRootElement(), "onStartInScoresResource")
Line 35: Line 28:


==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 -->
{{Resource_functions}}
{{Resource_functions}}
[[Category:Needs_Checking]]
[[Category:Needs_Checking]]

Revision as of 23:43, 12 April 2007

This function retrieves the resource from which the function call was made.

Syntax

resource getThisResource ( )

Returns

Returns the resource in which the current script is.

Example

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

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetThisResource?oldid=7930"