GetResourceName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Added OOP syntax)
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getResourceName ( resource )
string getResourceName ( resource res )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[resource]]:getName|name}}


===Required Arguments===  
===Required Arguments===  
*'''resource:''' The resource you wish to get the name of.
*'''res:''' The resource you wish to get the name of.


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


==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: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