GetResourceFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added link to resource wiki page)
No edit summary
Line 2: Line 2:
{{Server client function}}
{{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).
 
{{ Warning| For security, this function returns ''false'' with not started resources in client. }}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 12:54, 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).

[[|link=|]] Warning: For security, this function returns false with not started resources in client.

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.

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