GetResourceState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added a description and example. May need a list of returns)
mNo edit summary
Line 53: Line 53:
==See Also==
==See Also==
{{Resource functions}}
{{Resource functions}}
--[[Category:Incomplete]]

Revision as of 01:02, 7 January 2008

This function returns the state of a given reesource

Syntax

string getResourceState ( resource res ) 

Required Arguments

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

Returns

Returns a string with the resource state in it.
- false on fail

Example

Click to collapse [-]
Server

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

function getState( player, command, sz )
	if sz then
		local bFound = false
		local resourceTable = getResources() -- get a table of resources
	
		for resourceKey, resourceValue in ipairs( resourceTable ) do
			-- iterate through the table and output each resource's name
			local name = getResourceName( resourceValue )
			if string.lower( name ) == string.lower( sz ) then
				outputChatBox( "Resource State: " .. name .. " is currently " .. getResourceState( resourceValue ), player, 0, 0, 255 )
				bFound = true
				break
			end
		end
	
		if bFound ~= true then
			outputChatBox( "Error: No resource found named: " .. sz, player, 255, 0, 0 )
		end
	else
		outputChatBox( "Error: You did not specify a resource to check", player, 255, 0, 0 )
	end
end

addCommandHandler( "state", getState )

See Also