love.filesystem (Français)

love.filesystem propose une interface de gestion des fichiers côté utilisateur.


Néanmoins, le champ d'action de ce module est restreint à ces quelques emplacements :

  • L'archive .love qui contient le jeu (ou, si elle n'existe pas, le répertoire source dans lequel est stocké le jeu).
  • Le dossier de sauvegarde du jeu.
  • Le dossier parent contenant l'archive .love (ou, le cas échéant, le répertoire source dans lequel est stocké le jeu) si et seulement si certaines conditions sont réunies.


Chaque jeu possède un répertoire sur le disque dur dans lequel on peut enregistrer des fichiers par le biais de love.filesystem. Il est important de noter qu'il s'agît du seul répertoire dans lequel love.filesystem peut écrire.


Par défaut, on trouve ces répertoires dans les emplacements suivants :

  • Windows XP : C:\Documents and Settings\user\Application Data\LOVE\ ou %appdata%\LOVE\.
  • Windows Vista et Windows 7 : C:\Users\user\AppData\Roaming\LOVE ou %appdata%\LOVE\.
  • Linux : $XDG_DATA_HOME/love/ ou ~/.local/share/love/.
  • Mac OS : /Users/user/Library/Application Support/LOVE/.
  • Android : /data/user/0/org.love2d.android/files/save/ ou /data/data/org.love2d.android/files/save/ (on trouve différents emplacements de sauvegarde sous Android, si ces derniers ne fonctionnent pas, utilisez love.filesystem.getSaveDirectory() pour obtenir son emplacement).


L'écriture ou la modification de fichiers s’effectueront toujours dans le répertoire de sauvegarde. Les opérations semblables (comme mkdir) sont soumises aux mêmes contraintes.


Lors de la lecture de fichiers, il est de mise de retenir que les fichiers seront d'abord recherchés dans le dossier de sauvegarde, puis dans l'archive .love (ou, le cas échéant, dans le répertoire source qui stocke le jeu). Ainsi, sur deux fichiers possédant le même nom (et le même chemin d'accès) se trouvant dans les deux emplacements, on note que c'est le fichier se trouvant dans le dossier de sauvegarde qui aura la priorité.


Note : Tous les chemins d'accès sont relatifs au dossier de sauvegarde et à l'archive .love (excepté pour l'utilisation de get*Directory()).


Il vous est recommandé de déclarer l'identité de votre jeu (qui correspond au nom du dossier de sauvegarde) dans votre conf.lua. Vous pouvez utiliser love.filesystem.setIdentity pour le faire.


Objets

FileRepresents a file on the filesystem.
FileDataData representing the contents of a file.

Fonctions

love.filesystem.appendAppend data to an existing file.
love.filesystem.areSymlinksEnabledGets whether love.filesystem follows symbolic links.
love.filesystem.createDirectoryCreates a directory.
love.filesystem.enumerateReturns all the files and subdirectories in the directory.
love.filesystem.existsCheck whether a file or directory exists.
love.filesystem.getAppdataDirectoryReturns the application data directory (could be the same as getUserDirectory)
love.filesystem.getDirectoryItemsReturns all the files and subdirectories in the directory.
love.filesystem.getIdentityGets the write directory name for your game.
love.filesystem.getLastModifiedGets the last modification time of a file.
love.filesystem.getRealDirectoryGets the absolute path of the directory containing a filepath.
love.filesystem.getRequirePathGets the filesystem paths that will be searched when require is called.
love.filesystem.getSaveDirectoryGets the full path to the designated save directory.
love.filesystem.getSizeGets the size in bytes of a file.
love.filesystem.getSourceReturns the full path to the directory containing the .love file or directory.
love.filesystem.getSourceBaseDirectoryReturns the full path to the directory containing the .love file.
love.filesystem.getUserDirectoryReturns the path of the user's directory
love.filesystem.getWorkingDirectoryGets the current working directory.
love.filesystem.initInitializes love.filesystem, will be called internally, so should not be used explictly.
love.filesystem.isDirectoryCheck whether something is a directory.
love.filesystem.isFileCheck whether something is a file.
love.filesystem.isFusedGets whether the game is in fused mode or not.
love.filesystem.isSymlinkGets whether a filepath is actually a symbolic link.
love.filesystem.linesIterate over the lines in a file.
love.filesystem.loadLoads a Lua file (but does not run it).
love.filesystem.mkdirCreates a directory.
love.filesystem.mountMounts a zip file or folder in the game's save directory for reading.
love.filesystem.newFileCreates a new File object.
love.filesystem.newFileDataCreates a new FileData object.
love.filesystem.readRead the contents of a file
love.filesystem.removeRemoves a file (or directory).
love.filesystem.setIdentitySets the write directory for your game.
love.filesystem.setRequirePathSets the filesystem paths that will be searched when require is called.
love.filesystem.setSourceSets the source of the game, where the code is present. Used internally.
love.filesystem.setSymlinksEnabledSets whether love.filesystem follows symbolic links.
love.filesystem.unmountUnmounts a zip file or folder previously mounted with love.filesystem.mount.
love.filesystem.writeWrite data to a file.

Enums

FileDecoderHow to decode a given FileData.
FileModeThe different modes you can open a File in.


Voir aussi

Autres Langues