RenameResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Add missing OOP info)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{New feature/item|3.0120|1.2|3316|
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function renames a resource. '''Please Note:''' You can't change a running resource, only resources that's loaded/stopped.
This function renames a resource.


==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|name|getResourceName}}
===Required Arguments===  
===Required Arguments===  
*'''resourceName:''' The name of resource to rename.
*'''theResource:''' The name of resource or the resource you want to rename.
*'''newResourceName:''' The name of what the resource should be renamed to.
*'''newResourceName:''' The name of what the resource should be renamed to.


Line 20: Line 19:


==Example==
==Example==
This example renames the resource "realdriveby" to "driveby" when the current resource is started.
This example renames the resource "reload" to "reload2":
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
<syntaxhighlight lang="lua">function renameReloadResource()
renameResource("realdriveby","driveby")
renameResource("reload", "reload2");
end)
end
addEventHandler("onResourceStart", resourceRoot, renameReloadResource);
</syntaxhighlight>
</syntaxhighlight>


Latest revision as of 13:37, 10 August 2021

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

Requirements

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


Retrieved from "https://wiki.multitheftauto.com/wiki/RenameResource?oldid=71634"