GetResourceState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Remove section)
(add oop syntax)
Line 11: Line 11:
===Required Arguments===  
===Required Arguments===  
*'''theResource:''' The resource you wish to get the name of.
*'''theResource:''' The resource you wish to get the name of.
 
{{OOP||[[resource]]:getState|state}}
===Returns===
===Returns===
If successful returns a string with the resource state in it, ''false'' otherwise.
If successful returns a string with the resource state in it, ''false'' otherwise.

Revision as of 16:34, 1 January 2015

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.

OOP Syntax Help! I don't understand this!

Method: resource:getState(...)
Variable: .state


Returns

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

  • loaded
  • running

Example

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