Difference between revisions of "love.filesystem (Français)"

(Uncluttering seems to work, proceeding)
(Rewriting of the grammatically incorrect French sentences ; Updating of the module's specific access places ; Updating of the list of save directory's locations ; Add sentences who were missing ; Increase spacing between elements)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
Fournit une interface pour le système de fichiers des utilisateurs.
+
[[love.filesystem]] propose une interface de gestion des fichiers côté utilisateur.
  
Ce module fournit l'accès aux fichiers dans deux endroits et seulement deux endroits:
 
  
*  Le dossier racine de .love-file. (Alternativement un répertoire).
+
Néanmoins, le champ d'action de ce module est restreint à ces quelques emplacements :
*  Le dossier racine du répertoire donné.
+
  
A chaque jeu est accordé un seul répertoire sur le système où les fichiers peuvent être sauvés grâce à love.filesystem. Ces répertoires vont être typiquement trouvés dans quelque chose comme:
+
*  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 [[love.filesystem.getSourceBaseDirectory|certaines conditions]] sont réunies.
  
*  Windows XP: <code>C:\Documents and Settings\user\Application Data\Love\</code> or <code>%appdata%\Love\</code>
 
* Windows Vista and 7: <code>C:\Users\user\AppData\Roaming\LOVE</code> or <code>%appdata%\Love\</code>
 
*  Linux: <code>/home/user/.love/</code> or <code>~/.love/</code>
 
*  mac: <code>/Library/Application Support/LOVE/</code>
 
  
Les fichiers qui sont ouverts pour l' écriture ou pour la modification seront toujours créés dans le répertoire de sauvegarde. Il en va de même pour les autres opérations qui impliquent l' écriture du système de fichiers tel que mkdir.
+
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.
  
Les fichiers qui seront ouverts pour la lecture seront recherché d'abord dans le répertoire de sauvegarde, puis dans le dossier racine du jeu (dans cet ordre). Donc si un fichier avec un certain nom (et son chemin) existe à la fois dans .love-file et le fichier de sauvegarde,  celui qui est dans le répertoire de sauvegarde a la priorité.
 
  
Note: '''Tous''' les chemins sont relatifs au répertoire de sauvegarde et au répertoire .love. (Excepté pour l'appel de get*Directory())
+
Par défaut, on trouve ces répertoires dans les emplacements suivants :
  
Actuellement, vous devez définir l'identité de votre jeu avec [[love.filesystem.setIdentity]].
+
*  Windows XP : <code>C:\Documents and Settings\user\Application Data\LOVE\</code> ou <code>%appdata%\LOVE\</code>.
== Types ==
+
*  Windows Vista et Windows 7 : <code>C:\Users\user\AppData\Roaming\LOVE</code> ou <code>%appdata%\LOVE\</code>.
 +
*  Linux : <code>$XDG_DATA_HOME/love/</code> ou <code>~/.local/share/love/</code>.
 +
*  Mac OS : <code>/Users/user/Library/Application Support/LOVE/</code>.
 +
*  Android : <code>/data/user/0/org.love2d.android/files/save/</code> ou <code>/data/data/org.love2d.android/files/save/</code> (on trouve différents emplacements de sauvegarde sous Android, si ces derniers ne fonctionnent pas, utilisez <code>love.filesystem.getSaveDirectory()</code> 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 [[Config Files|conf.lua]].
 +
Vous pouvez utiliser [[love.filesystem.setIdentity]] pour le faire.
 +
 
 +
 
 +
== Objets ==
 
{{#ask: [[Category:Types]] [[parent::love.filesystem]]
 
{{#ask: [[Category:Types]] [[parent::love.filesystem]]
 
| headers=hide
 
| headers=hide
 
| ?Description
 
| ?Description
 
}}
 
}}
 +
 
== Fonctions ==
 
== Fonctions ==
 
{{#ask: [[Category:Functions]] [[parent::love.filesystem]]
 
{{#ask: [[Category:Functions]] [[parent::love.filesystem]]
Line 30: Line 48:
 
| ?Description
 
| ?Description
 
}}
 
}}
 +
 
== Enums ==
 
== Enums ==
 
{{#ask: [[Category:Enums]] [[parent::love.filesystem]]
 
{{#ask: [[Category:Enums]] [[parent::love.filesystem]]
Line 35: Line 54:
 
| ?Description
 
| ?Description
 
}}
 
}}
 +
 
[[Category:Modules]]
 
[[Category:Modules]]
{{#set:Description=Provides an interface to the user's filesystem.
+
{{#set:Description=Module qui propose une interface de gestion des fichiers côté utilisateur}}
}}
+
 
 
== Voir aussi ==
 
== Voir aussi ==
 
* [[parent::love (Français)]]
 
* [[parent::love (Français)]]

Latest revision as of 15:00, 10 May 2017

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

DroppedFileRepresents a file dropped from the window.
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.getCRequirePathGets the filesystem paths that will be searched for c libraries when require is called.
love.filesystem.getDirectoryItemsReturns all the files and subdirectories in the directory.
love.filesystem.getIdentityGets the write directory name for your game.
love.filesystem.getInfoGets information about the specified file or directory.
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 .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.setCRequirePathSets the filesystem paths that will be searched for c libraries when require is called.
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.
FileTypeThe type of a file.


Voir aussi

Autres Langues