RenameResource: Difference between revisions

Latest revision as of 15:33, 7 November 2024

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(...)

Variable: .name

Counterpart: getResourceName

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);

@@ Line 7: / Line 7: @@
 bool renameResource ( string/resource theResource, string newResourceName, [ string organizationalPath ] )
 </syntaxhighlight>
-{{OOP||[[resource]]:rename}}
+{{OOP||[[resource]]:rename|name|getResourceName}}
 ===Required Arguments===
 *'''theResource:''' The name of resource or the resource you want to rename.
@@ Line 25: / Line 25: @@
 addEventHandler("onResourceStart", resourceRoot, renameReloadResource);
 </syntaxhighlight>
-==Requirements==
-{{Requirements|1.1.1-9.03316|n/a|}}
 ==See Also==
-{{Resource_functions}}
+{{Resource_functions|server}}