GetResourceState: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Added the new states "starting" and "stopping") |
||
Line 17: | Line 17: | ||
*'''loaded''' | *'''loaded''' | ||
*'''running''' | *'''running''' | ||
{{New feature|3|DP3| | |||
*'''starting''' | |||
*'''stopping''' | |||
}} | |||
==Example== | ==Example== |
Revision as of 15:19, 5 September 2008
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
- starting
- stopping
Example
Click to collapse [-]
ServerThis 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
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo