Difference between revisions of "love.filesystem.setIdentity"

(Arguments)
(Setting the game folder name)
 
(2 intermediate revisions by the same user not shown)
Line 19: Line 19:
 
{{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|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.
 
{{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.
FALSE: results in searching source before searching save directory
+
TRUE: results in searching source before searching save directory;
TRUE: results in searching game save directory before searching source directory
+
FALSE: results in searching game save directory before searching source directory[[love.filesystem.mount|mounted]] archives.}}
[[love.filesystem.mount|mounted]] archives.}}
+
  
 
=== Returns ===
 
=== Returns ===
Line 34: Line 33:
 
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]]

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