GetResourceState: Difference between revisions
Jump to navigation
Jump to search
m (Improved the example) |
|||
Line 27: | Line 27: | ||
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"> | ||
function getState( player, command, | function getState( player, command, resourceName ) | ||
if | if resourceName then | ||
local | 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 ) | |||
outputChatBox( "Error: No resource | |||
end | end | ||
else | else | ||
outputChatBox( " | outputChatBox( "Syntax: " .. command .. " [resource name]", player, 255, 0, 0 ) | ||
end | end | ||
end | end |
Revision as of 14:56, 7 May 2010
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
- failed to load - Use getResourceLoadFailureReason to find out why it failed.
Example
Click to collapse [-]
ServerThis 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
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo