GetResourceName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Add default parameter)
 
(10 intermediate revisions by 7 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function gets the name of the specified resource.
This function gets the name of the specified resource.
{{New feature/item|3.0161|1.6.0|22620|
Specifying the resource parameter is not mandatory now, in this case this resource is used as a basis
}}
{{Note| Every resource has a predefined global variable called resourceName whose value is the name of that resource.}}
{{Note| If you want to access the name of any ''resource-data'' you should use [[getElementID]].}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getResourceName ( resource )
string getResourceName ( [ resource res = getThisResource() ] )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[resource]]:getName|name|renameResource}}


===Required Arguments===  
===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

Latest revision as of 20:55, 15 July 2024

This function gets the name of the specified resource.

ADDED/UPDATED IN VERSION 1.6.0 r22620:

Specifying the resource parameter is not mandatory now, in this case this resource is used as a basis

[[{{{image}}}|link=|]] Note: Every resource has a predefined global variable called resourceName whose value is the name of that resource.
[[{{{image}}}|link=|]] Note: If you want to access the name of any resource-data you should use getElementID.

Syntax

string getResourceName ( [ resource res = getThisResource() ] )

OOP Syntax Help! I don't understand this!

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


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=79904"