GetResourceLoadFailureReason: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Add missing OOP info)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Server function}}
This function is used to determinate the reason for a resource to not start.
__NOTOC__
This function retrieves the reason why a resource failed to start.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getResourceLoadFailureReason ( resource )
string getResourceLoadFailureReason ( resource theResource )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[resource]]:getLoadFailureReason|loadFailureReason}}


===Required Arguments===  
===Required Arguments===  
*'''resource:''' The resource you wish to check.
*'''theResource:''' The resource you wish to check.


===Returns===
===Returns===
Returns a string with the failure reason in it, or ''false'' if the resource doesn't exist.
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==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
This example does...
This example checks if there's a resource that failed to load, then outputs "Resource: 'resourceName' failed to load because 'reason'." .
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
for _,v in ipairs(getResources())do --loop through all the resources
blabhalbalhb --abababa
if getResourceState(v)=="failed to load" then --check if it failed to load
--This line does this...
outputChatBox("Resource: "..getResourceName(v).." failed to load because: "..getResourceLoadFailureReason(v)..".") --output why it didn't load
mooo
end
end
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Resource functions}}
{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

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 [-]
Server

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

See Also

Shared



Retrieved from "https://wiki.multitheftauto.com/wiki/GetResourceLoadFailureReason?oldid=71635"