GetResourceFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(add oop syntax)
No edit summary
Line 7: Line 7:
resource getResourceFromName ( string resourceName )
resource getResourceFromName ( string resourceName )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[Resource]]}}
{{OOP|Static method [[Resource]].fromName() can also be used|[[Resource]]}}
===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 16:20, 1 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: Static method Resource.fromName() can also be used
Method: Resource(...)


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