RenameResource: Difference between revisions
(update 1st arg) |
No edit summary |
||
Line 9: | Line 9: | ||
{{OOP||[[resource]]:rename}} | {{OOP||[[resource]]:rename}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theResource:''' The name of resource or the resource | *'''theResource:''' The name of resource or the resource you want to rename. | ||
*'''newResourceName:''' The name of what the resource should be renamed to. | *'''newResourceName:''' The name of what the resource should be renamed to. | ||
Revision as of 03:14, 3 June 2020
This function renames a resource.
Syntax
bool renameResource ( string/resource theResource, string newResourceName, [ string organizationalPath ] )
OOP Syntax Help! I don't understand this!
- Method: resource:rename(...)
Required Arguments
- theResource: The name of resource or the resource you want to rename.
- newResourceName: The name of what the resource should be renamed to.
Optional Arguments
- organizationalPath: If you want to store the new resource inside a category.
Returns
Returns true if the resource has been renamed successfully, false otherwise. This could fail if the resource name already is in use, if a directory already exists with the name you've specified (but this isn't a valid resource) or if the name you specify isn't valid. It could also fail if the disk was full or for other similar reasons. Won't work on a started resource or if the resource is not loaded (not known by MTA (use /refresh))
Example
This example renames the resource "reload" to "reload2":
function renameReloadResource() renameResource("reload", "reload2"); end addEventHandler("onResourceStart", resourceRoot, renameReloadResource);
Requirements
Minimum server version | 1.1.1-9.03316 |
---|---|
Minimum client version | n/a |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.1.1-9.03316" />
See Also
- abortRemoteRequest
- addResourceConfig
- addResourceMap
- call
- callRemote
- copyResource
- createResource
- deleteResource
- fetchRemote
- getRemoteRequestInfo
- getRemoteRequests
- getResourceACLRequests
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceName
- getResourceOrganizationalPath
- getResourceRootElement
- getResources
- getResourceState
- getThisResource
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest