GetResourceFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(add oop syntax)
m (add oop note)
Line 7: Line 7:
resource getResourceFromName ( string resourceName )
resource getResourceFromName ( string resourceName )
</syntaxhighlight>
</syntaxhighlight>
{{OOP|This function is a static function underneath the Resource class.|[[Resource]].getFromName}}
{{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===  
*'''resourceName:''' the name of the resource you wish to get.
*'''resourceName:''' the name of the resource you wish to get.

Revision as of 13:56, 11 January 2015

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