File functions

Author: FileEX

elements/File/file.yaml

@@ -0,0 +1,3 @@
+name: 'file'
+description: |
+    THIS FUNCTION NEEDS DOCUMENTATION

functions/File/examples/fileClose-1.lua

@@ -0,0 +1,5 @@
+local newFile = fileCreate("test.txt")                -- attempt to create a new file
+if newFile then                                       -- check if the creation succeeded
+    fileWrite(newFile, "This is a test file!")        -- write a text line
+    fileClose(newFile)                                -- close the file once you're done with it
+end

functions/File/examples/fileCopy-1.lua

@@ -0,0 +1,9 @@
+addEventHandler("onClientResourceStart", resourceRoot, function(res)
+    local filePath = ":"..getResourceName(res).."/test.txt"
+    fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
+    if fileCopy(filePath,":"..getResourceName(res).."/test1.txt") then
+         outputChatBox("File was successfully copied!", 0, 100, 0)
+    else
+        outputChatBox("File was not successfully copied, probably because it doesn't exist.", 100, 0, 0)
+    end
+end)

functions/File/examples/fileCopy-2.lua

@@ -0,0 +1,9 @@
+addEventHandler("onResourceStart", resourceRoot, function(res)
+    local filePath = ":"..getResourceName(res).."/test.txt"
+    fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
+    if fileCopy(filePath, ":"..getResourceName(res).."/test1.txt") then
+         outputChatBox("File was successfully copied!", root, 0, 100, 0)
+    else
+         outputChatBox("File was not successfully copied, probably because it doesn't exist.", root, 100, 0, 0)
+    end
+end)

functions/File/examples/fileCreate-1.lua

@@ -0,0 +1,5 @@
+local newFile = fileCreate("test.txt")                -- attempt to create a new file
+if (newFile) then                                       -- check if the creation succeeded
+    fileWrite(newFile, "This is a test file!")        -- write a text line
+    fileClose(newFile)                                -- close the file once you're done with it
+end

functions/File/examples/fileDelete-1.lua

@@ -0,0 +1,6 @@
+local newFile = fileCreate("test.txt")                -- attempt to create a new file
+if (newFile) then                                     -- check if the creation succeeded
+    fileWrite(newFile, "This is a test file!")        -- write a text line
+    fileClose(newFile)                                -- close the file once you're done with it
+    fileDelete("test.txt")                            -- delete file
+end

functions/File/examples/fileExists-1.lua

@@ -0,0 +1,22 @@
+function checkExistingFile(player,cmd,filename,resourcename)
+	if not filename then -- if the player didn't include a filename
+		outputChatBox("ERROR: Syntax '/checkfile filename resourcename(optional)'.",player) -- display error
+		return false  -- stop function
+	end
+	if not resourcename then -- if the player didn't specify the resource he wants to check, use current resource
+		resourcename = getResourceName(resource) --every resource has a predefined global variable called resource that contains the resource pointer for that resource, in other words, the value that getThisResource() function returns.
+	else
+		if not getResourceFromName(resourcename) then -- if a resource with that name doesn't exist, output error and stop function
+			outputChatBox("ERROR: Resource "..resourcename.." doesn't exist.",player) -- output error message
+			return false -- stop the function here
+		end
+	end
+	-- as it hasn't stopped anywhere, we have both correct resourcename and filename
+	local exists = fileExists((":%s/%s"):format(resourcename,filename)) -- using shorter format of string.format, see StringLibraryTutorial in lua wiki for that
+	if exists then
+		outputChatBox(("The file %q in resource %q exists"):format(filename,resourcename))
+	else
+		outputChatBox(("The file %q in resource %q doesn't exist"):format(filename,resourcename))
+	end
+end
+addCommandHandler("exists",checkExistingFile)

functions/File/examples/fileFlush-1.lua

@@ -0,0 +1,7 @@
+local fileHandle = fileCreate("test.txt")
+if fileHandle then
+    fileWrite(fileHandle, "Line 1")
+    fileFlush(fileHandle)
+    -- ... further writing operations
+    fileClose(fileHandle)
+end

functions/File/examples/fileGetContents-1.lua

@@ -0,0 +1,7 @@
+local handle = fileOpen("code.lua", true)
+local buffer = fileGetContents(handle) -- code.lua must be listed in meta.xml (for example as <file> for this example)
+fileClose(handle)
+
+if buffer then
+    loadstring(buffer)() -- This is just an example. You should avoid using loadstring. If you are dealing with configuration use json functions instead for security reasons.
+end

functions/File/examples/fileGetPath-1.lua

@@ -0,0 +1,6 @@
+local newFile = fileCreate("test.txt")                -- attempt to create a new file
+if (newFile) then                                       -- check if the creation succeeded
+    local path = fileGetPath(newFile)
+    outputChatBox("New file created at: "..path, root, 0, 255, 0)
+    fileClose(newFile)                                -- close the file once you're done with it
+end