GetResourceFromName: Difference between revisions

From Multi Theft Auto: Wiki
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 fake function is for use with blah & blah and does blahblahblabhalbhl
This function is used to retrieve a resource from it's name. A resource's name is the same as it's folder or file archive name on the server (without the extension).


==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">
getResourceFromName ( string )
resource getResourceFromName ( string resourceName )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''argumentName:''' description
*'''resourceName:''' A string indicating the name of the resource you wish to get.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===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 ''true'' if blah, ''false'' otherwise.<br \>
Returns a resource object, or '''false''' if no resource of that name exists.
Returns a resource, false on fail


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<!-- Explain what the example is in a single sentance -->
This example does...
This example outputs a message when a resource named "playerblips" starts:
<!-- 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">
--This line does...
addEventHandler("onResourceStart", getRootElement(), "onStart")
blabhalbalhb --abababa
function onStart(resource)
--This line does this...
    local blipsResource = getResourceFromName("playerblips") -- get the resource of name "playerblips"
mooo
    if (blipsResource and resource == blipsResource) then -- check if the resource started was it
          outputChatBox("Blips resource started!")
    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 -->
{{FunctionArea_functions}}
{{Resource_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 00:41, 12 April 2007

This function is used to retrieve a resource from it's name. A resource's name is the same as it's folder or file archive name on the server (without the extension).

Syntax

resource getResourceFromName ( string resourceName )

Required Arguments

  • resourceName: A string indicating the name of the resource you wish to get.

Returns

Returns a resource object, or false if no resource of that name exists.

Example

This example outputs a message when a resource named "playerblips" starts: 

addEventHandler("onResourceStart", getRootElement(), "onStart")
function onStart(resource)
     local blipsResource = getResourceFromName("playerblips") -- get the resource of name "playerblips"
     if (blipsResource and resource == blipsResource) then -- check if the resource started was it
          outputChatBox("Blips resource started!")
     end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetResourceFromName?oldid=7898"