Difference between revisions of "love.filesystem.setIdentity"

(Added new 0.9.0 variant with search order)
m (Function: Updated optional second argument)
Line 14: Line 14:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.filesystem.setIdentity( name, searchorder )
+
love.filesystem.setIdentity( name, appendToPath )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|string|name|The new identity that will be used as write directory}}
 
{{param|string|name|The new identity that will be used as write directory}}
{{param|SearchOrder|searchorder ("first")|Whether love.filesystem will look for files in the write directory before or after looking in the main game source.}}
+
{{param|boolean|appendToPath (false)|Whether the identity directory will be searched when reading a filepath before or after the game's source directory and any archives currently mounted with [[love.filesystem.mount]].}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== Examples ==
 
== Examples ==
 
=== Setting the game folder name ===
 
=== Setting the game folder name ===

Revision as of 21:09, 30 October 2013

Sets the write directory for your game. Note that you can only set the name of the folder to store your files in, not the location.

Function

Synopsis

love.filesystem.setIdentity( name )

Arguments

string name
The new identity that will be used as write directory

Returns

Nothing.

Function

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

Synopsis

love.filesystem.setIdentity( name, appendToPath )

Arguments

string name
The new identity that will be used as write directory
boolean appendToPath (false)
Whether the identity directory will be searched when reading a filepath before or after the game's source directory and any archives currently mounted with love.filesystem.mount.

Returns

Nothing.

Examples

Setting the game folder name

-- Yes:
love.filesystem.setIdentity("monkey_doom_2")
-- No: 
-- love.filesystem.setIdentity("c:/Users/bob/monkey_doom_2")

See Also


Other Languages