GetResourceState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Improved the example)
No edit summary
Line 1: Line 1:
{{Server function}}
{{Server client function}}
__NOTOC__
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
Line 24: Line 24:


==Example==  
==Example==  
<section class="server" name="Server" show="true">
<section class="shared" name="Server and client" show="true">
This example returns the state of a given resource. Syntax: ''/state <Resource Name>''
This example returns the state of a given resource. Syntax: ''/state <Resource Name>''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 15:29, 15 May 2014

This function returns the state of a given resource

Syntax

string getResourceState ( resource theResource )

Required Arguments

  • theResource: The resource you wish to get the name of.

Returns

If successful returns a string with the resource state in it, false otherwise. The state can be one of:

  • loaded
  • running

Example

Click to collapse [-]
Server and client

This example returns the state of a given resource. Syntax: /state <Resource Name> 

function getState( player, command, resourceName )
	if resourceName then
		local resource = getResourceFromName( resourceName )
		if resource then
			outputChatBox( "Resource State: " .. resourceName .. " is currently " .. getResourceState( resource ) .. ".", player, 0, 0, 255 )
		else
			outputChatBox( "Error: No resource with name " .. resourceName .. " exists.", player, 255, 0, 0 )
		end
	else
		outputChatBox( "Syntax: " .. command .. " [resource name]", player, 255, 0, 0 )
	end
end

addCommandHandler( "state", getState )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetResourceState?oldid=39540"