GetResourceLoadFailureReason: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Add missing OOP info) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
string getResourceLoadFailureReason ( resource theResource ) | string getResourceLoadFailureReason ( resource theResource ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[resource]]:getLoadFailureReason|loadFailureReason}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 16: | Line 17: | ||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
This example checks if there's a resource that failed to load, then outputs "Resource: 'resourceName' failed to load because 'reason'." . | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | for _,v in ipairs(getResources())do --loop through all the resources | ||
if getResourceState(v)=="failed to load" then --check if it failed to load | |||
outputChatBox("Resource: "..getResourceName(v).." failed to load because: "..getResourceLoadFailureReason(v)..".") --output why it didn't load | |||
end | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
| Line 23: | Line 29: | ||
==See Also== | ==See Also== | ||
{{Resource functions}} | {{Resource functions}} | ||
Latest revision as of 13:39, 10 August 2021
This function retrieves the reason why a resource failed to start.
Syntax
string getResourceLoadFailureReason ( resource theResource )
OOP Syntax Help! I don't understand this!
- Method: resource:getLoadFailureReason(...)
- Variable: .loadFailureReason
Required Arguments
- theResource: The resource you wish to check.
Returns
If the resource failed to load, returns a string with the failure reason in it. If it loaded successfully, returns an empty string. Returns false if the resource doesn't exist.
Example
Click to collapse [-]
ServerThis example checks if there's a resource that failed to load, then outputs "Resource: 'resourceName' failed to load because 'reason'." .
for _,v in ipairs(getResources())do --loop through all the resources
if getResourceState(v)=="failed to load" then --check if it failed to load
outputChatBox("Resource: "..getResourceName(v).." failed to load because: "..getResourceLoadFailureReason(v)..".") --output why it didn't load
end
end
See Also
- addResourceConfig
- addResourceMap
- callRemote
- copyResource
- createResource
- deleteResource
- getResourceACLRequests
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceOrganizationalPath
- getResources
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest
Shared
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo
- abortRemoteRequest