GetResourceLoadFailureReason: Difference between revisions

Revision as of 16:33, 20 June 2007

This function is used to determinate the reason for a resource to not start.

string getResourceLoadFailureReason ( resource )

Returns a string with the failure reason in it, or false if the resource doesn't exist.

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

@@ Line 1: / Line 1: @@
 __NOTOC__
-<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+This function is used to determinate the reason for a resource to not start.
-This fake function is for use with blah & blah and does blahblahblabhalbhl
 ==Syntax==
-<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
 <syntaxhighlight lang="lua">
 string getResourceLoadFailureReason ( resource )
@@ Line 10: / Line 8: @@
 ===Required Arguments===
-<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
+*'''resource:''' The resource you wish to check.
-*'''argumentName:''' description
-<!-- Only include this section below if there are optional arguments -->
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' description
-*'''argumentName3:''' description
 ===Returns===
-<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
+Returns a string with the failure reason in it, or ''false'' if the resource doesn't exist.
-Returns ''true'' if blah, ''false'' otherwise. <br \>
-false on fail
 ==Example==