GetResources: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function retrieves a table of all the resources that exist on the server.
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">
table getResources ()
table getResources ()
Line 10: Line 8:


===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 a table of resource objects.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This function displays the names of all the resources on the server (?):
<!-- 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">
function displayResources()
function displayResources()
Line 30: 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}}
{{Resource_functions}}
[[Category:Needs_Checking]] -- leave this unless you complete the function

Revision as of 23:45, 12 April 2007

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

Syntax

table getResources ()

Returns

Returns a table of resources.

Example

function displayResources()
     outputConsole("List of resources:")
     local resourceTable = getResources() -- get a table of resources
     for resourceKey, resourceValue in 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=7931"