GetResourceInfo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Needs_Checking|may return a string, bool or nil (?) --[[User:Jbeta|jbeta]]}}
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function retrieves the value of any attribute in a resource info tag.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==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">
<syntaxhighlight lang="lua">
getResourceInfo ( resource, string )  
string getResourceInfo ( resource theResource, string attribute )  
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===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 -->
*'''theResource:''' the resource we are getting the info from.
*'''argumentName:''' description
*'''attribute:''' the name of the attribute we want info about.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===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 attribute value if it exists, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise. <br \>
may return a string, bool or nil


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
This example does...
<!-- 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...
--This line does...
Line 36: Line 24:


==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]]
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 23:51, 12 April 2007

Dialog-information.png This article needs checking.
Reason(s): may return a string, bool or nil (?) --jbeta

This function retrieves the value of any attribute in a resource info tag.

Syntax

string getResourceInfo ( resource theResource, string attribute )

Required Arguments

  • theResource: the resource we are getting the info from.
  • attribute: the name of the attribute we want info about.

Returns

Returns a string with the attribute value if it exists, false otherwise.

Example

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

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetResourceInfo?oldid=7951"