RenameResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(add oop syntax)
(update 1st arg)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool renameResource ( string resourceName, string newResourceName, [ string organizationalPath ] )
bool renameResource ( string/resource theResource, string newResourceName, [ string organizationalPath ] )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[resource]]:rename}}
{{OOP||[[resource]]:rename}}
===Required Arguments===  
===Required Arguments===  
*'''resourceName:''' The name of resource to rename.
*'''theResource:''' The name of resource or the resource element 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:07, 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 element 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

This template will be deleted.

See Also