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)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server client function}}
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).
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).


Line 5: Line 6:
<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===  
Line 11: Line 13:


===Returns===
===Returns===
Returns the ''resource'' with the specified name, or ''false'' if no resource of that name exists.
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==  
==Example==
<section name="Server" class="server" show="true">
This example prints out a message to the chatbox when a resource named ''playerblips'' is started.
<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==
{{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"