Difference between revisions of "love.filesystem.setIdentity"

(Added new 0.9.0 variant with search order)
(Setting the game folder name)
 
(7 intermediate revisions by 3 users not shown)
Line 7: Line 7:
 
</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.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
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 currently.
 +
TRUE: results in searching source before searching save directory;
 +
FALSE: results in searching game save directory before searching source directory[[love.filesystem.mount|mounted]] archives.}}
 +
 
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== Examples ==
 
== Examples ==
 
=== Setting the game folder name ===
 
=== Setting the game folder name ===
Line 27: Line 31:
 
love.filesystem.setIdentity("monkey_doom_2")
 
love.filesystem.setIdentity("monkey_doom_2")
 
-- No:  
 
-- No:  
-- love.filesystem.setIdentity("c:/Users/bob/monkey_doom_2")
+
love.filesystem.setIdentity("c:/Users/bob/monkey_doom_2")
 
</source>
 
</source>
 +
=== Setting which to search first ===
 +
<source lang="lua">
 +
--Search Source, then the save directory
 +
love.filesystem.setIdentity(love.filesystem.getIdentity(),true)
 +
--Search Save directory, then the Source Directory
 +
love.filesystem.setIdentity(love.filesystem.getIdentity(),false)
 +
</source>
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.filesystem]]
 
* [[parent::love.filesystem]]
 +
* [[love.filesystem.getIdentity]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Sets the write directory for your game.}}
 
{{#set:Description=Sets the write directory for your game.}}

Latest revision as of 05:43, 21 October 2015

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 currently.

TRUE: results in searching source before searching save directory; FALSE: results in searching game save directory before searching source directorymounted archives.

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")

Setting which to search first

--Search Source, then the save directory
love.filesystem.setIdentity(love.filesystem.getIdentity(),true)
--Search Save directory, then the Source Directory
love.filesystem.setIdentity(love.filesystem.getIdentity(),false)

See Also


Other Languages