From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function renames a resource.


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


This example renames the resource "reload" to "reload2":

function renameReloadResource()
	renameResource("reload", "reload2");
addEventHandler("onResourceStart", resourceRoot, renameReloadResource);


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