Manual:File System Functions - Revision history

Tamarindo: /* openMudletHomeDir */

2026-02-04T02:51:10Z

openMudletHomeDir

2026-02-04T01:24:13Z

saveProfile

2024-05-04T07:52:14Z

File System Functions: note about LFS

2021-01-05T09:28:59Z

add documentation text for page

2020-11-01T23:27:47Z

io.exists: add path argument

2018-08-12T22:47:35Z

lfs.attributes: add returned values

2018-08-12T22:47:06Z

io.exists: add returned values

2017-06-29T23:28:32Z

Imcreasing headline levels for visibility

2017-06-29T04:09:01Z

File System Functions

2017-03-26T09:50:56Z

io.exists: fixed in 3.0

@@ Line 52: / Line 52: @@
 [[Category:Mudlet API]]
 [[Category:Mudlet Manual]]
 ==saveProfile==

← Older revision		Revision as of 01:24, 4 February 2026
Line 52:		Line 52:
	[[Category:Mudlet API]]		[[Category:Mudlet API]]
	[[Category:Mudlet Manual]]		[[Category:Mudlet Manual]]
		+
		+	==saveProfile==
		+	;saveProfile([location, [filename]])
		+
		+	:Saves the current Mudlet profile to disk, which is equivalent to pressing the "Save Profile" button.
		+
		+	{{MudletVersion\|4.20}}
		+
		+	;Parameters
		+	* ''location:''
		+	:(optional) folder to save the profile to. If not given, the profile will go into the [[Mudlet_File_Locations\|default location]].
		+
		+	* ''filename:''
		+	:(optional) save the profile as the filename. If the filename doesn't end with ''.xml'' this function will automatically save it as ''filename.xml''. If not given, the profile will be saved with the default ''DATE#TIME.xml'' filename format.
		+
		+	;Example
		+	<syntaxhighlight lang="lua">
		+	-- save profile to the .../mudlet/profiles/profileName/current folder
		+	saveProfile()
		+
		+	-- save to the desktop on Windows:
		+	saveProfile([[C:\Users\yourusername\Desktop]])
		+
		+	-- alternately, save to the desktop with the name system.xml:
		+	saveProfile([[C:\Users\yourusername\Desktop]],"system")
		+	</syntaxhighlight>

@@ Line 3: / Line 3: @@
 = File System Functions =
 A collection of functions for interacting with the file system.
 ==io.exists==

@@ Line 1: / Line 1: @@
 {{TOC right}}
 = File System Functions =
 A collection of functions for interacting with the file system.

@@ Line 4: / Line 4: @@
 ==io.exists==
-; TrueOrFalse = io.exists()
+; io.exists(path)
 : Checks to see if a given file or folder exists.
 : If it exists, it’ll return the Lua true boolean value, otherwise false.

@@ Line 27: / Line 27: @@
 ==lfs.attributes==
-; lfs.attributes(path)
+; infoTable = lfs.attributes(path)
 : Returns a table with detailed information regarding a file or directory, or nil if path is invalid / file or folder does not exist.

@@ Line 10: / Line 10: @@
 ;Example
-<lua>
+<syntaxhighlight lang="lua">
 -- This example works on Linux only
 if io.exists("/home/vadi/Desktop") then
@@ Line 24: / Line 24: @@
    echo("This file doesn't exist.")
 end
-</lua>
+</syntaxhighlight>
 ===lfs.attributes===
@@ Line 31: / Line 31: @@
 ;Example
-<lua>
+<syntaxhighlight lang="lua">
 fileInfo = lfs.attributes("/path/to/file_or_directory")
 if fileInfo then
@@ Line 45: / Line 45: @@
      echo("The path is invalid (file/directory doesn't exist)")
 end
-</lua>
+</syntaxhighlight>
 [[Category:Mudlet API]]
 [[Category:Mudlet Manual]]

@@ Line 5: / Line 5: @@
 ===io.exists===
 ; io.exists()
 : Checks to see if a given file or folder exists.
 : If it exists, it’ll return the Lua true boolean value, otherwise false.
 : See [[Manual:Miscellaneous_Functions#lfs.attributes|lfs.attributes()]] for a cross-platform solution.