love.filesystem (日本語)

利用者のファイルシステムへのインターフェースを提供します。

このモジュールは特定の場所にあるファイルへのアクセスを提供します:

  • .love アーカイブ (またはソースのディレクトリ) のルート・フォルダ。
  • ゲームのセーブ・ディレクトリのルート・フォルダ。
  • ゲームの .love アーカイブ (またはソース・ディレクトリ) のあるフォルダですが、特定の条件を満たしている場合に限ります。

love.filesystem によりゲームごとにシステムへファイルを保存できるディレクトリを提供します。このディレクトリのみ love.filesystem はファイルを書き込めます。これらのディレクトリは主にこのようものとして見つかります:

  • Windows XP: C:\Documents and Settings\user\Application Data\LOVE\ または %appdata%\LOVE\
  • Windows Vista および 7: C:\Users\user\AppData\Roaming\LOVE または %appdata%\LOVE\
  • Linux: $XDG_DATA_HOME/love/ または ~/.local/share/love/
  • Mac: /Users/user/Library/Application Support/LOVE/
  • Android: /data/user/0/org.love2d.android/files/save/ または /data/data/org.love2d.android/files/save/ Android では様々なセーブ先があります。これらが動作しない場合は、love.filesystem.getSaveDirectory() を確認のために使用できます。)

書き込みまたは追記を行うためファイルを開いた場合は常にセーブ・ディレクトリに作成されます。同様に mkdir のような、ファイルシステムへの書き込みを含むその他の操作でも該当します。

ファイルを読み取るために開く場合はセーブ・ディレクトリおよびその後に .love アーカイブを(この順序にて)検索します。したがって、あるファイル名称(およびパス)を持つファイルがセーブ・ディレクトリおよび .love アーカイブの両方に存在する場合は、セーブ・ディレクトリ優先します。

注釈: 全てのパスは .love アーカイブおよびセーブ・ディレクトリからの相対パスです(get*Directory() の呼び出しを除く)。

最初にゲームの識別子を conf.lua で設定することを推奨します。同様に love.filesystem.setIdentity でも設定できます。

File (日本語) ファイルシステムにあるファイルを提供します。
FileData (日本語) ファイルの内容を Data として提供します。 Added since 0.7.0

関数

love.filesystem.append (日本語) 既存ファイルへデータを追記します。 Added since 0.9.0
love.filesystem.areSymlinksEnabled (日本語) love.filesystem がシンボリック・リンクを辿るかどうかを取得します。 Added since 0.9.2
love.filesystem.createDirectory (日本語) ディレクトリを作成します。 Added since 0.9.0
love.filesystem.enumerate (日本語) ディレクトリにある全てのファイルおよびサブディレクトリを返します。 Added since 0.3.0 Removed in 0.9.0
love.filesystem.exists (日本語) ファイルまたはディレクトリが存在するか確認します。
love.filesystem.getAppdataDirectory (日本語) アプリケーションのデータディレクトリを返します (getUserDirectory と同じ場合があります)
love.filesystem.getDirectoryItems (日本語) ディレクトリにある全てのファイルおよびサブディレクトリを返します。 Added since 0.9.0
love.filesystem.getIdentity (日本語) ゲームの書き込み先のディレクトリ名を取得します。 Added since 0.9.0
love.filesystem.getLastModified (日本語) ファイルの最終更新時刻を取得します。 Added since 0.7.1
love.filesystem.getRealDirectory (日本語) ファイルパスがあるディレクトリの絶対パスを取得します。 Added since 0.9.2
love.filesystem.getRequirePath (日本語) require が呼ばれた時に検索されるファイルシステムのパスを取得します。 Added since 0.10.0
love.filesystem.getSaveDirectory (日本語) 明示されたセーブ・ディレクトリのフルパスを取得します。
love.filesystem.getSize (日本語) ファイルの大きさをバイトで取得します。 Added since 0.9.0
love.filesystem.getSourceBaseDirectory (日本語) .love ファイルのあるディレクトリのフルパスを返します。 Added since 0.9.0
love.filesystem.getUserDirectory (日本語) 利用者のディレクトリのパスを返します。
love.filesystem.getWorkingDirectory (日本語) 現在の作業ディレクトリを取得します。
love.filesystem.init (日本語) love.filesystem を初期化しますが、これはシステム内部で呼ばれるものであるため、明示的に使用しないでください。
love.filesystem.isDirectory (日本語) 対象がディレクトリかどうか確認します。
love.filesystem.isFile (日本語) 対象がファイルかどうか確認します。
love.filesystem.isFused (日本語) ゲームがヒューズ・モードであるかどうか取得します。 Added since 0.9.0
love.filesystem.isSymlink (日本語) ファイルパスが本当にシンボリック・リンクであるかどうかを取得します。 Added since 0.9.2
love.filesystem.lines (日本語) ファイルの最終行までイテレート(反復)します。
love.filesystem.load (日本語) lua ファイルを読み込みます (が実行はしません)。
love.filesystem.mkdir (日本語) 再帰的にディレクトリを作成します。 Removed in 0.9.0
love.filesystem.mount (日本語) 読み取るために zip ファイルまたはフォルダをゲームのセーブ・ディレクトリへマウント(装着)します。 Added since 0.9.0
love.filesystem.newFile (日本語) File オブジェクトを新規作成します。
love.filesystem.newFileData (日本語) FileData オブジェクトを新規作成します。 Added since 0.7.0
love.filesystem.read (日本語) ファイルの内容を読み込みます。
love.filesystem.remove (日本語) ファイルを削除します (またはディレクトリ)。
love.filesystem.setIdentity (日本語) ゲームの書き込み先ディレクトリを設定します。
love.filesystem.setRequirePath (日本語) require が呼ばれた時に検索されるファイルシステムのパスを設定します。 Added since 0.10.0
love.filesystem.setSource (日本語) ゲームのソースとして、どこにコードが存在するのかを設定します。
love.filesystem.setSymlinksEnabled (日本語) love.filesystem がシンボリック・リンクを辿るように設定します。 Added since 0.9.2
love.filesystem.unmount (日本語) 以前に love.filesystem.mount で読み取るためにマウントした zip ファイルまたはフォルダをアンマウント(脱着)します。 Added since 0.9.0
love.filesystem.write (日本語) ファイルへデータを書き込みます。

列挙型

FileDecoder (日本語) FileData の復号化方法を指定します。 Added since 0.7.0
FileMode (日本語) 様々なモードでファイルを開くことができるようにします。

関連

そのほかの言語