GetResourceName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Added OOP syntax)
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Server client 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 gets the name of the specified resource.


==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 )
string getResourceName ( resource res )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[resource]]:getName|name}}


===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 -->
*'''res:''' The resource you wish to get the name of.
*'''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 string with the resource name in it, or ''false'' if the resource does not exist.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
<section class="server" name="Server" show="true">
This example does...
This simple example outputs a message in the console whenever a resource starts, stating the name of the resource.
<!-- 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...
addEventHandler("onResourceStart", getRootElement(),
blabhalbalhb --abababa
    function(res)
--This line does this...
        outputConsole("Resource " .. getResourceName(res) .. " just started.")
mooo
    end
)
</syntaxhighlight>
</syntaxhighlight>
</section>


==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:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 17:29, 26 November 2014

This function gets the name of the specified resource.

Syntax

string getResourceName ( resource res )

OOP Syntax Help! I don't understand this!

Method: resource:getName(...)
Variable: .name


Required Arguments

  • res: The resource you wish to get the name of.

Returns

Returns a string with the resource name in it, or false if the resource does not exist.

Example

Click to collapse [-]
Server

This simple example outputs a message in the console whenever a resource starts, stating the name of the resource. 

addEventHandler("onResourceStart", getRootElement(),
    function(res)
        outputConsole("Resource " .. getResourceName(res) .. " just started.")
    end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetResourceName?oldid=43068"