Difference between revisions of "love.filesystem.mountFullPath"

(Created page)
 
m (Add default value to permission.)
 
Line 9: Line 9:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|string|archive|The full platform-dependent path to a folder or zip file to mount.}}
 
{{param|string|archive|The full platform-dependent path to a folder or zip file to mount.}}
{{param|string|mountpoint|The new path in love.filesystem the archive will be mounted to.}}
+
{{param|string|mountpoint|The new path in love.filesystem the archive or the platform-dependent path will be mounted to.}}
{{param|MountPermissions|permission|The requested permissions for operating on files and folders in this path after mounting ("read", or "readwrite").}}
+
{{param|MountPermissions|permission ("read")|The requested permissions for operating on files and folders in this path after mounting ("read", or "readwrite").}}
 
{{param|boolean|appendToPath (false)|Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.}}
 
{{param|boolean|appendToPath (false)|Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.}}
 
=== Returns ===
 
=== Returns ===

Latest revision as of 06:09, 14 April 2024

Available since LÖVE 12.0
This function is not supported in earlier versions.

Mounts a full platform-dependent path to a zip file or folder for reading or writing in love.filesystem.

Function

Synopsis

success = love.filesystem.mountFullPath( archive, mountpoint, permission, appendToPath )

Arguments

string archive
The full platform-dependent path to a folder or zip file to mount.
string mountpoint
The new path in love.filesystem the archive or the platform-dependent path will be mounted to.
MountPermissions permission ("read")
The requested permissions for operating on files and folders in this path after mounting ("read", or "readwrite").
boolean appendToPath (false)
Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.

Returns

boolean success
True if the archive was successfully mounted with the given path and permissions, false otherwise.

Notes

Most operating systems allow apps to read from more locations than they're allowed to write to. Therefore, this API will succeed in more situations when the "read" mount permission is used compared to "readwrite".

See Also

Other Languages