GetResourceFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (add oop note)
m (Added link to resource wiki page)
Line 13: 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.


==Example==
==Example==

Revision as of 15:56, 27 October 2016

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.

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=49665"