RenameResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{New feature|3.0120|1.2| __NOTOC__ {{Server function}} This function renames a resource. ==Syntax== <syntaxhighlight lang="lua"> bool renameResource ( string resourceName, string newResourc...")
 
No edit summary
Line 23: Line 23:
-- No example yet
-- No example yet
</syntaxhighlight>
</syntaxhighlight>
}}


==See Also==
==See Also==
{{Resource_functions}}
{{Resource_functions}}
[[Category:Needs_Example]]
[[Category:Needs_Example]]
}}

Revision as of 16:35, 17 October 2011

This function renames a resource.

Syntax

bool renameResource ( string resourceName, string newResourceName, [ string organizationalPath ] )

Required Arguments

  • resourceName: The name of resource 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

-- No example yet

See Also