GetResourceFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (move clientside caveat to returns section)
 
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
{{Server client function}}
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).
This function is used to retrieve a resource from its name. A resource's name is the same as its 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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
resource getResourceFromName ( string resourceName )
resource getResourceFromName ( string resourceName )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP|This function is a static function underneath the Resource class. {{New feature/item|3.0141|1.4.1|7005|OOP function available client side}}|[[Resource]].getFromName}}


===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 -->
*'''resourceName:''' the name of the resource you wish to get.
*'''resourceName:''' A string indicating the name of the resource you wish to get.


===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]] with the specified name, or ''false'' if no resource of that name exists. Note that clientside this will also return ''false'' for resources that are in the ''loaded'' state, since the client is unaware of resources that have not been started.
Returns a resource object, or '''false''' if no resource of that name exists.


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
This example outputs a message when a resource named "playerblips" starts:
This example prints out a message to the chatbox when a resource named ''playerblips'' is started.
<!-- 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(), "onStart")
function onStart( theResource )
function onStart(resource)
     local blipsResource = getResourceFromName ( "playerblips" ) -- get the resource of name "playerblips"
     local blipsResource = getResourceFromName("playerblips") -- get the resource of name "playerblips"
     if ( blipsResource and theResource == blipsResource ) then -- check if the resource started was it
     if (blipsResource and resource == blipsResource) then -- check if the resource started was it
           outputChatBox ( "Blips resource started!" )
           outputChatBox("Blips resource started!")
     end
     end
end
end
addEventHandler ( "onResourceStart", getRootElement(), onStart )
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Latest revision as of 13:04, 4 February 2020

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

Syntax

resource getResourceFromName ( string resourceName )

OOP Syntax Help! I don't understand this!

Note: This function is a static function underneath the Resource class. OOP function available client side
Method: Resource.getFromName(...)


Required Arguments

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

Returns

Returns the resource with the specified name, or false if no resource of that name exists. Note that clientside this will also return false for resources that are in the loaded state, since the client is unaware of resources that have not been started.

Example

Click to collapse [-]
Server

This example prints out a message to the chatbox when a resource named playerblips is started. 

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

See Also


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