"use strict";(self.webpackChunkdocs_site=self.webpackChunkdocs_site||[]).push([[4554],{1351:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"XXTLanControl.lua/web-file/move","title":"Move Files Or Directories (LCC.web_file.move)","description":"Signature","source":"@site/i18n/en/docusaurus-plugin-content-docs/current/XXTLanControl.lua/web-file/move.md","sourceDirName":"XXTLanControl.lua/web-file","slug":"/XXTLanControl.lua/web-file/move","permalink":"/docs/en/XXTLanControl.lua/web-file/move","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":290,"frontMatter":{"sidebar_position":290},"sidebar":"tutorialSidebar","previous":{"title":"Copy With Overwrite-And-Merge (LCC.web_file.copy_overwrite_merge)","permalink":"/docs/en/XXTLanControl.lua/web-file/copy_overwrite_merge"},"next":{"title":"Move And Overwrite (LCC.web_file.move_overwrite)","permalink":"/docs/en/XXTLanControl.lua/web-file/move_overwrite"}}');var i=n(4848),t=n(8453);const s={sidebar_position:290},l="Move Files Or Directories (LCC.web_file.move)",a={},c=[{value:"Signature",id:"signature",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Notes",id:"notes",level:2},{value:"Example",id:"example",level:2}];function d(e){const r={blockquote:"blockquote",br:"br",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"move-files-or-directories-lccweb_filemove",children:"Move Files Or Directories (LCC.web_file.move)"})}),"\n",(0,i.jsx)(r.h2,{id:"signature",children:"Signature"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-lua",children:"ok, err = LCC.web_file.move(src, target, mode?, timeout?)\n"})}),"\n",(0,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsxs)(r.li,{children:["src",(0,i.jsx)(r.br,{}),"\n","String. Source path."]}),"\n",(0,i.jsxs)(r.li,{children:["target",(0,i.jsx)(r.br,{}),"\n","String. Destination path."]}),"\n",(0,i.jsxs)(r.li,{children:["mode",(0,i.jsx)(r.br,{}),"\n","String, optional. Move mode, default ",(0,i.jsx)(r.code,{children:'"normal"'}),"; supports ",(0,i.jsx)(r.code,{children:'"overwrite"'}),", ",(0,i.jsx)(r.code,{children:'"merge"'}),", ",(0,i.jsx)(r.code,{children:'"overwrite-merge"'}),"."]}),"\n",(0,i.jsxs)(r.li,{children:["timeout",(0,i.jsx)(r.br,{}),"\n","Number, optional. Request timeout in seconds, default ",(0,i.jsx)(r.code,{children:"60"}),"."]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsxs)(r.li,{children:["ok",(0,i.jsx)(r.br,{}),"\n","Boolean. ",(0,i.jsx)(r.code,{children:"true"})," on success, ",(0,i.jsx)(r.code,{children:"nil"})," on failure."]}),"\n",(0,i.jsxs)(r.li,{children:["err",(0,i.jsx)(r.br,{}),"\n","String or ",(0,i.jsx)(r.code,{children:"nil"}),". Error description when the move fails."]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"notes",children:"Notes"}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:["Moves files or directories; also useful for renaming.",(0,i.jsx)(r.br,{}),"\n","When ",(0,i.jsx)(r.code,{children:"src"})," is a symlink, the move operates on the link itself and does not rewrite or remove the target content.",(0,i.jsx)(r.br,{}),"\n","In ",(0,i.jsx)(r.code,{children:"normal"})," mode the operation fails if the target already exists; other modes behave like their shorthand helpers."]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-lua",children:'local ok, err = LCC.web_file.move("/scripts/temp.lua", "/scripts/main.lua", "overwrite")\nif not ok then\n    error(err)\nend\n'})})]})}function u(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>s,x:()=>l});var o=n(6540);const i={},t=o.createContext(i);function s(e){const r=o.useContext(t);return o.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(t.Provider,{value:r},e.children)}}}]);