GetResourceName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Add default parameter) |
||
(14 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | {{Server client function}} | ||
__NOTOC__ | |||
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 res = getThisResource() ] ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[resource]]:getName|name|renameResource}} | |||
===Arguments=== | |||
=== | *'''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. | |||
==Example== | ==Example== | ||
< | <section class="server" name="Server" show="true"> | ||
This example | This simple example outputs a message in the console whenever a resource starts, stating the name of the resource. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addEventHandler("onResourceStart", getRootElement(), | |||
function(res) | |||
outputConsole("Resource " .. getResourceName(res) .. " just started.") | |||
end | |||
) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Resource functions}} | |||
{{ | |||
Latest revision as of 20:55, 15 July 2024
This function gets the name of the specified resource.
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 [-]
ServerThis 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
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo