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

(update translation following current english documentation page)
 
Line 1: Line 1:
[[love.filesystem]] propose une interface de gestion des fichiers côté utilisateur.
+
Fournit une interface de gestion du système de fichiers de l'utilisateur.
  
 +
Ce module fournit des accès aux fichiers dans des emplacements spécifiques :
 +
* Le répertoire racine de l'archive .love (ou le répertoire source)
 +
* Le répertoire racine du dossier de sauvegarde du jeu.
 +
* Le répertoire contenant l'archive .love du jeu (ou le répertoire source), mais seulement, si [[love.filesystem.getSourceBaseDirectory|certaines conditions]] sont réunies.
 +
Chaque jeu est autorisé à un simple dossier du système, où les fichiers peuvent être sauvegardés via love.filesystem. C'est le seul répertoire où love.filesysteme peut écrire des fichiers. Ces répertoires se situent typiquement dans quelque chose comme :
  
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).
+
{| border="1" cellpadding="5" cellspacing="1" style="background-color:#E9F5FF; border: 1px solid #83C0F0;"
*  Le dossier de sauvegarde du jeu.
+
! OS
*  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.
+
! Chemin
 +
! Alternative
 +
! Notes
 +
|-
 +
    |Windows XP
 +
    |<code>C:\Documents and Settings\user\Application Data\LOVE\</code>
 +
    |<code>%appdata%\LOVE\</code>
 +
    |Lorsque fusionné, un répertoire de sauvegarde sera crée directement à l'intérieur de <code>Application Data</code>, plutôt que dans un sous-répertoire de <code>LOVE</code>.
 +
|-
 +
    |Windows Vista, 7, 8 et 10
 +
    |<code>C:\Users\user\AppData\Roaming\LOVE</code>
 +
    |<code>%appdata%\LOVE\</code>
 +
    |Lorsque fusionné, un répertoire de sauvegarde sera crée directement à l'intérieur de <code>AppData</code>, plutôt que dans un sous-répertoire de <code>LOVE</code>.
 +
|-
 +
    |Mac
 +
    |<code>/Users/user/Library/Application Support/LOVE/</code>
 +
    | -
 +
    | -
 +
|-
 +
    |Linux
 +
    |<code>$XDG_DATA_HOME/love/</code>
 +
    |<code>~/.local/share/love/</code>
 +
    | -
 +
|-
 +
    |Android
 +
    |<code>/data/user/0/org.love2d.android/files/save/</code>
 +
    |<code>/data/data/org.love2d.android/files/save/</code>
 +
    |Sous Android il y à différentes emplacements de sauvegarde. SI ceux-ci ne fonctionnent pas, vous pouvez utiliser la fonction <code>[[love.filesystem.getSaveDirectory (Français)|love.filesystem.getSaveDirectory()]]</code> pour vérifier.
 +
|}
  
  
Chaque jeu possède un répertoire sur le disque dur dans lequel on peut enregistrer des fichiers par le biais de [[love.filesystem]].
+
Les fichiers qui sont ouvert en écriture ou ajout seront toujours créés dans de le répertoire de sauvegarde. Il en va de même pour les autres opérations qui impliquent des écritures sur le système de fichier, comme createDirectory.
Il est important de noter qu'il s'agît du '''seul répertoire''' dans lequel [[love.filesystem]] peut écrire.
 
  
 +
Les fichiers ouverts en lecture seront d'abord cherché dans le dossier de sauvegarde, puis ensuite dans l'archive .love (dans cet ordre). Donc, si un fichier avec un certain nom de fichier (et chemin) existe à la fois dans l'archive .love et dans le dossier de sauvegarde, celui du répertoire de sauvegarde et lu en priorité.
  
Par défaut, on trouve ces répertoires dans les emplacements suivants :
+
Note: '''Tous''' les chemins sont relatifs à l'archive .love et au répertoire de sauvegarde. (à l'exception des appels à get*Directory())
  
*  Windows XP : <code>C:\Documents and Settings\user\Application Data\LOVE\</code> ou <code>%appdata%\LOVE\</code>.
+
Il est recommandé de régler l'identité de votre jeu en premier dans votre fichier [[Config Files (Français)|conf.lua]]. Vous pouvez également le régler à l'aide de [[love.filesystem.setIdentity (Français)|love.filesystem.setIdentity]].
*  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.
 
  
 
+
== Types ==
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).
+
{{#ask: [[Category:Types (Français)]] [[parent::love.filesystem (Français)]] [[Concept:Current]]
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]]
 
 
| headers=hide
 
| headers=hide
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 
| ?Description
 
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 +
| ?PrettyDeprecated
 
}}
 
}}
 
 
== Fonctions ==
 
== Fonctions ==
{{#ask: [[Category:Functions]] [[parent::love.filesystem]]
+
{{#ask: [[Category:Functions (Français)]] [[parent::love.filesystem (Français)]] [[Concept:Current]]
 
| headers=hide
 
| headers=hide
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 
| ?Description
 
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 +
| ?PrettyDeprecated
 
}}
 
}}
 
 
== Enums ==
 
== Enums ==
{{#ask: [[Category:Enums]] [[parent::love.filesystem]]
+
{{#ask: [[Category:Enums (Français)]] [[parent::love.filesystem (Français)]] [[Concept:Current]]
 
| headers=hide
 
| headers=hide
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 
| ?Description
 
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 
}}
 
}}
 
 
[[Category:Modules (Français)]]
 
[[Category:Modules (Français)]]
{{#set:Description=Module qui propose une interface de gestion des fichiers côté utilisateur}}
+
{{#set:Description=Fournit une interface de gestion du système de fichiers de l'utilisateur.}}
 
+
== Voir également ==
== Voir aussi ==
 
 
* [[parent::love (Français)]]
 
* [[parent::love (Français)]]
 
+
{{#set:Since=000}}
== Autres Langues ==
+
== Autres langues ==
 
{{i18n|love.filesystem}}
 
{{i18n|love.filesystem}}

Latest revision as of 23:45, 24 January 2021

Fournit une interface de gestion du système de fichiers de l'utilisateur.

Ce module fournit des accès aux fichiers dans des emplacements spécifiques :

  • Le répertoire racine de l'archive .love (ou le répertoire source)
  • Le répertoire racine du dossier de sauvegarde du jeu.
  • Le répertoire contenant l'archive .love du jeu (ou le répertoire source), mais seulement, si certaines conditions sont réunies.

Chaque jeu est autorisé à un simple dossier du système, où les fichiers peuvent être sauvegardés via love.filesystem. C'est le seul répertoire où love.filesysteme peut écrire des fichiers. Ces répertoires se situent typiquement dans quelque chose comme :


OS Chemin Alternative Notes
Windows XP C:\Documents and Settings\user\Application Data\LOVE\ %appdata%\LOVE\ Lorsque fusionné, un répertoire de sauvegarde sera crée directement à l'intérieur de Application Data, plutôt que dans un sous-répertoire de LOVE.
Windows Vista, 7, 8 et 10 C:\Users\user\AppData\Roaming\LOVE %appdata%\LOVE\ Lorsque fusionné, un répertoire de sauvegarde sera crée directement à l'intérieur de AppData, plutôt que dans un sous-répertoire de LOVE.
Mac /Users/user/Library/Application Support/LOVE/ - -
Linux $XDG_DATA_HOME/love/ ~/.local/share/love/ -
Android /data/user/0/org.love2d.android/files/save/ /data/data/org.love2d.android/files/save/ Sous Android il y à différentes emplacements de sauvegarde. SI ceux-ci ne fonctionnent pas, vous pouvez utiliser la fonction love.filesystem.getSaveDirectory() pour vérifier.


Les fichiers qui sont ouvert en écriture ou ajout seront toujours créés dans de le répertoire de sauvegarde. Il en va de même pour les autres opérations qui impliquent des écritures sur le système de fichier, comme createDirectory.

Les fichiers ouverts en lecture seront d'abord cherché dans le dossier de sauvegarde, puis ensuite dans l'archive .love (dans cet ordre). Donc, si un fichier avec un certain nom de fichier (et chemin) existe à la fois dans l'archive .love et dans le dossier de sauvegarde, celui du répertoire de sauvegarde et lu en priorité.

Note: Tous les chemins sont relatifs à l'archive .love et au répertoire de sauvegarde. (à l'exception des appels à get*Directory())

Il est recommandé de régler l'identité de votre jeu en premier dans votre fichier conf.lua. Vous pouvez également le régler à l'aide de love.filesystem.setIdentity.


Types

DroppedFile (Français) Represents a file dropped from the window. Added since 0.10.0
FileData (Français) Data (données) représentant le contenu d'un fichier.

Fonctions

love.filesystem.append (Français) Ajoute des données à un fichier existant.
love.filesystem.areSymlinksEnabled (Français) Vérifie si love.filesystem suit les liens symboliques.
love.filesystem.createDirectory (Français) Crée un répertoire, récursivement.
love.filesystem.getAppdataDirectory (Français) Retourne le répertoire de données de l'application (pourrait être le même que getUserDirectory)
love.filesystem.getCRequirePath (Français) Récupère les chemins du système de fichier qui vont être recherchés pour les bibliothèques en c lorsque require (requiert) est appelé.
love.filesystem.getDirectoryItems (Français) Retourne la liste des fichiers et sous-dossiers contenus dans un dossier.
love.filesystem.getIdentity (Français) Récupère le nom du dossier d'écriture de votre jeu.
love.filesystem.getInfo (Français) Récupère des informations à propos d'un fichier ou répertoire spécifié.
love.filesystem.getRealDirectory (Français) Récupère le chemin absolu du dossier contenant le chemin de fichier.
love.filesystem.getRequirePath (Français) Récupère les chemins du système de fichier qui seront recherchés lorsque require (requiert) est appelé.
love.filesystem.getSaveDirectory (Français) Récupère le chemin complet du répertoire de sauvegarde désigné.
love.filesystem.getSource (Français) Retourne le chemin complet du fichier ou répertoire .love.
love.filesystem.getUserDirectory (Français) Retourne le chemin du répertoire de l'utilisateur
love.filesystem.getWorkingDirectory (Français) Récupère le répertoire de travail actuel.
love.filesystem.init (Français) Initialise love.filesystem, sera appelé en interne, ne devrait donc pas être utilisé explicitement.
love.filesystem.isFused (Français) Gets whether the game is in fused mode or not.
love.filesystem.isSymlink (Français) Vérifie si un chemin de fichier est un lien symbolique.
love.filesystem.lines (Français) Lit des lignes par itérations dans un fichier.
love.filesystem.load (Français) Charge un fichier Lua (mais ne l’exécute qu'optionnellement).
love.filesystem.mount (Français) Monte un fichier zip ou un dossier dans le répertoire de sauvegarde du jeu pour lecture.
love.filesystem.newFile (Français) Crée un nouvel objet File.
love.filesystem.newFileData (Français) Crée un nouvel objet FileData (données de fichier) à partir d'un fichier sur le système de fichiers ou d'une chaîne de caractères en mémoire. Added since 0.7.0
love.filesystem.read (Français) Lit le contenu d'un fichier.
love.filesystem.setCRequirePath (Français) Règle les chemins du système de fichier qui vont être recherchés pour les bibliothèques en c lorsque require (requiert) est appelé..
love.filesystem.setIdentity (Français) Règle le dossier d'écriture de votre jeu.
love.filesystem.setRequirePath (Français) Règle les chemins du système de fichier qui seront recherchés lorsque require (requiert) est appelé.
love.filesystem.setSource (Français) Règle les sources du jeu, où le code est présent. Utilisé en interne.
love.filesystem.setSymlinksEnabled (Français) Règle si le love.filesystem doit suivre les liens symboliques.
love.filesystem.unmount (Français) Démonte un fichier zip ou un dossier monté auparavant avec love.filesystem.mount.
love.filesystem.write (Français) Écrit des données dans un fichier.

Enums

FileDecoder (Français) Comment décoder un FileData (données de fichier) donnée. Added since 0.7.0 Removed in 11.0
FileMode (Français) Les différents modes dans lesquels vous pouvez ouvrir un File (fichier).
FileType (Français) Le type d'un fichier. Added since 11.0

Voir également

Autres langues