GetResourceName: Difference between revisions
Jump to navigation
Jump to search
Tag: Undo |
(Add default parameter) |
||
| (One intermediate revision by one other 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|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| 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]].}} | ||
| Line 11: | Line 14: | ||
{{OOP||[[resource]]:getName|name|renameResource}} | {{OOP||[[resource]]:getName|name|renameResource}} | ||
=== | ===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 20:55, 15 July 2024
This function gets the name of the specified resource.
| 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
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
- addResourceConfig
- addResourceMap
- callRemote
- copyResource
- createResource
- deleteResource
- getResourceACLRequests
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceOrganizationalPath
- getResources
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest
Shared
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo
- abortRemoteRequest