Skip to content

getResourceLoadFailureReason

Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.


This function retrieves the reason why a resource failed to start.

OOP Syntax Help! I don't understand this!

  • Method:resource:getLoadFailureReason(...)
  • Variable: .loadFailureReason

Syntax

string getResourceLoadFailureReason ( ​resource theResource )
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.

  • string: value

Code Examples

shared

This 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