Difference between revisions of "love.filesystem.mount"

(Created page)
 
m (Arguments)
Line 20: Line 20:
 
{{param|string|archive|The folder or zip file in the game's save directory to mount.}}
 
{{param|string|archive|The folder or zip file in the game's save directory to mount.}}
 
{{param|string|mountpoint|The new path the archive will be mounted to.}}
 
{{param|string|mountpoint|The new path the archive will be mounted to.}}
{{param|SearchOrder|searchorder ("first")|Whether the archive will be searched before or after already-mounted archives. This includes the game's source and save directories.}}
+
{{param|SearchOrder|searchorder ("first")|Whether the archive will be searched when opening or reading a file before or after already-mounted archives. This includes the game's source and save directories.}}
 +
 
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|success|True if the archive was successfully mounted, false otherwise.}}
 
{{param|boolean|success|True if the archive was successfully mounted, false otherwise.}}

Revision as of 19:55, 30 October 2013

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.

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, searchorder )

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.
SearchOrder searchorder ("first")
Whether the archive will be searched when opening or reading a file 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