GetResourceName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add beta header)
(Undo revision 79710 by Nico834 (talk))
Tag: Undo
 
(One intermediate revision by the same user 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|22592|
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]].}}
{{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 res = getThisResource() ] )
string getResourceName ( resource res )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[resource]]:getName|name|renameResource}}
{{OOP||[[resource]]:getName|name|renameResource}}


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


Latest revision as of 13:01, 5 July 2024

This function gets the name of the specified resource.

[[{{{image}}}|link=|]] Note: If you want to access the name of any resource-data you should use getElementID.

Syntax

string getResourceName ( resource res )

OOP Syntax Help! I don't understand this!

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


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

Shared



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