GetResources: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(add oop syntax)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Server function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function retrieves a table of all the resources that exist on the server.


==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">
returnType functionName ( arguments )
table getResources ()
</syntaxhighlight>  
</syntaxhighlight>
 
{{OOP||[[Resource]].getAll}}
===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 -->
*'''argumentName:''' description
 
<!-- 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 table of resources.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
This function lists all loaded resources in the console.
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 displayResources()
blabhalbalhb --abababa
    outputConsole("List of resources:")
--This line does this...
    local resourceTable = getResources() -- get a table of resources
mooo
    for resourceKey, resourceValue in ipairs(resourceTable) do
          -- iterate through the table and output each resource's name
          local name = getResourceName(resourceValue)
          outputConsole(" " .. name)
    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}}
{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Latest revision as of 18:26, 24 June 2017

This function retrieves a table of all the resources that exist on the server.

Syntax

table getResources ()

OOP Syntax Help! I don't understand this!

Method: Resource.getAll(...)


Returns

Returns a table of resources.

Example

This function lists all loaded resources in the console. 

function displayResources()
     outputConsole("List of resources:")
     local resourceTable = getResources() -- get a table of resources
     for resourceKey, resourceValue in ipairs(resourceTable) do
          -- iterate through the table and output each resource's name
          local name = getResourceName(resourceValue)
          outputConsole(" " .. name)
     end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetResources?oldid=51325"