RenameResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{New feature|3.0120|1.2|  
{{New feature/item|3.0120|1.2|3316|
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
Line 20: Line 20:


==Example==
==Example==
<syntaxhighlight lang="lua">
{{Example}}
-- No example yet
</syntaxhighlight>
}}
}}



Revision as of 06:51, 21 November 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

Accessories-text-editor.png Script Example Missing Function RenameResource needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.
-- TODO

Requirements

This template will be deleted.

See Also