Difference between revisions of "love.filesystem.mount"

m (Updated optional third argument)
m (Add note that the source base directory can be mounted in fused mode)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
 
Mounts a zip file or folder in the game's save directory for reading.
 
Mounts a zip file or folder in the game's save directory for reading.
 +
It is also possible to mount [[love.filesystem.getSourceBaseDirectory]] if the game is in fused mode.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 36: Line 37:
 
* [[parent::love.filesystem]]
 
* [[parent::love.filesystem]]
 
* [[love.filesystem.unmount]]
 
* [[love.filesystem.unmount]]
 +
* [[love.filesystem.getSourceBaseDirectory]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Mounts a zip file or folder in the game's save directory for reading.}}
 
{{#set:Description=Mounts a zip file or folder in the game's save directory for reading.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.filesystem.mount}}
 
{{i18n|love.filesystem.mount}}

Revision as of 02:05, 12 July 2017

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

Mounts a zip file or folder in the game's save directory for reading. It is also possible to mount love.filesystem.getSourceBaseDirectory if the game is in fused mode.

Function

Synopsis

success = love.filesystem.mount( archive, mountpoint )

Arguments

string archive
The folder or zip file in the game's save directory to mount.
string mountpoint
The new path the archive will be mounted to.

Returns

boolean success
True if the archive was successfully mounted, false otherwise.

Function

Synopsis

success = love.filesystem.mount( archive, mountpoint, appendToPath )

Arguments

string archive
The folder or zip file in the game's save directory to mount.
string mountpoint
The new path the archive will be mounted to.
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, false otherwise.

Examples

Mount a zip file.

-- Assuming content.zip exists in the game's save directory and contains a file called 'myimage.png'.
love.filesystem.mount("content.zip", "content")

assert(love.filesystem.exists("content/myimage.png"))

See Also

Other Languages