GetResourceInfo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
{{server function}}
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function retrieves the value of any attribute in a resource info tag.


==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>  
 
{{OOP||[[resource]]:getInfo}}
===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.
- may return a string, bool or nil


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
This function tells the server who's the author who made the currently running resource.
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...
function outputAuthor()
blabhalbalhb --abababa
    author = getResourceInfo ( getThisResource(), "author" )    --Get the authors name
--This line does this...
    if author then    --if it exists
mooo
        outputChatBox( author .. " made this script." )    --tell the world his name
    else    --if it doesn't
        outputChatBox( "I've no idea who made this script." )    --apologize.
    end
end
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 22:46, 6 September 2024

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

Syntax

string getResourceInfo ( resource theResource, string attribute )

OOP Syntax Help! I don't understand this!

Method: resource:getInfo(...)


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 function tells the server who's the author who made the currently running resource. 

function outputAuthor()
    author = getResourceInfo ( getThisResource(), "author" )    --Get the authors name
    if author then    --if it exists
        outputChatBox( author .. " made this script." )    --tell the world his name
    else    --if it doesn't
        outputChatBox( "I've no idea who made this script." )    --apologize.
    end
end

See Also


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