ファイルの操作

ファイルの作成やアクセスにはさまざまな方法があります。ファイルパスとアクセス方法は、ファイルの種類と保存場所によって異なります。

ファイルやフォルダーへのアクセスに使う関数

Defold には、ファイルを操作するためのさまざまな関数があります。

• 標準の io.* 関数 を使って、ファイルの読み取りと書き込みができます。これらの関数では、I/O 処理全体を非常に細かく制御できます。

-- open myfile.txt for writing in binary mode
-- returns nil plus error message on failure
local f, err = io.open("path/to/myfile.txt", "wb")
if not f then
	print("Something went wrong while opening the file", err)
	return
end

-- write to the file, flush it to disk and then close the file
f:write("Foobar")
f:flush()
f:close()

-- open myfile.txt for reading in binary mode
-- returns nil plus error message on failure
local f, err = io.open("path/to/myfile.txt", "rb")
if not f then
	print("Something went wrong while opening the file", err)
	return
end

-- read the entire file as a string
-- returns nil on failure
local s = f:read("*a")
if not s then
	print("Error while reading file")
	return
end

print(s) -- Foobar

• os.rename() と os.remove() を使って、ファイルの名前変更と削除ができます。

• sys.save() と sys.load() を使って、Lua テーブルの読み取りと書き込みができます。ほかにも、プラットフォームに依存しないファイルパスの解決に役立つ sys.* 関数があります。

-- get a platform independent path to the file "highscore" for application "mygame"
local path = sys.get_save_file("mygame", "highscore")

-- save a Lua table with some data
local ok = sys.save(path, { highscore = 100 })
if not ok then
	print("Failed to save", path)
	return
end

-- load the data
local ok, data = pcall(sys.load, path)
if not ok then
	-- The file exists, but is corrupt, foreign, or uses an unsupported format.
	print("Failed to load save data:", data)
	data = {}
end
print(data.highscore) -- 100

sys.load() は、ファイルが存在しない場合、空のテーブルを返します。ファイルが存在していても、sys.save() で作成されていない、破損している、またはサポートされていないシリアライズ済みテーブルの形式を使用している場合、sys.load() は Lua エラーを発生させます。破損した保存データや外部で変更された保存データから復旧できるようにする必要がある場合は、上記のように pcall() を使います。

ファイルとフォルダーの場所

ファイルとフォルダーの場所は、次の3つに分類できます。

• アプリケーションが作成する、アプリケーション固有のファイル
• アプリケーションに同梱されるファイルとフォルダー
• アプリケーションがアクセスする、システム固有のファイル

アプリケーション固有のファイルを保存、読み込みする方法

ハイスコア、ユーザー設定、ゲームの状態など、アプリケーション固有のファイルを保存、読み込みする際は、オペレーティングシステムがこの目的専用に提供する場所を使うことをお勧めします。sys.get_save_file() を使うと、ファイルへの OS 固有の絶対パスを取得できます。絶対パスを取得したら、sys.*、io.*、os.* 関数を使えます（上記参照）。

sys.save() と sys.load() の使い方を示すサンプルを確認してください。

アプリケーションに同梱されたファイルにアクセスする方法

バンドルリソース（bundle resources）とカスタムリソース（custom resources）を使って、アプリケーションにファイルを同梱できます。

カスタムリソース

カスタムリソース（custom resource）は、game.project の Custom Resources フィールド を使って、ゲームのメインアーカイブに同梱されます。

Custom Resources フィールドには、ゲームのメインアーカイブに含めるリソースをカンマ区切りのリストで指定します。ディレクトリを指定すると、そのディレクトリ内のすべてのファイルとディレクトリが再帰的に含まれます。sys.load_resource() を使ってファイルを読み込めます。

-- Load level data into a string
local data, error = sys.load_resource("/assets/level_data.json")
-- Decode json string to a Lua table
if data then
  local data_table = json.decode(data)
  pprint(data_table)
else
  print(error)
end

バンドルリソース

バンドルリソース（bundle resources）は、game.project の Bundle Resources フィールド を使用してアプリケーションのバンドル（bundle）の一部として配置される、追加のファイルやフォルダーです。

Bundle Resources フィールドには、バンドル作成時に生成されるパッケージへそのままコピーするリソースファイルやフォルダーを含むディレクトリを、カンマ区切りで指定します。ディレクトリは、たとえば /res のように、プロジェクトのルートからの絶対パスで指定する必要があります。リソースディレクトリには、platform または architecture-platform という形式で名前を付けたサブフォルダーを含める必要があります。

サポートされているプラットフォームは、ios、android、osx、win32、linux、web、switch です。すべてのプラットフォームで共通のリソースファイルを含む、common という名前のサブフォルダーも使用できます。例:

res
├── win32
│   └── mywin32file.txt
├── common
│   └── mycommonfile.txt
└── android
    ├── myandroidfile.txt
    └── res
        └── xml
            └── filepaths.xml

sys.get_application_path() を使用すると、アプリケーションが保存されている場所のパスを取得できます。このアプリケーションのベースパスを使用して、アクセスする必要があるファイルへの最終的な絶対パスを作成します。これらのファイルの絶対パスを取得したら、io.* と os.* の関数を使用してファイルにアクセスできます。

local path = sys.get_application_path()
local f = io.open(path .. "/mycommonfile.txt", "rb")
local txt, err = f:read("*a")
if not txt then
	print(err)
	return
end
print(txt)

カスタムリソースとバンドルリソースの比較

システムファイルへのアクセス

セキュリティ上の理由から、オペレーティングシステムによってシステムファイルへのアクセスが制限されることがあります。extension-directories ネイティブ拡張（native extension）を使うと、一般的なシステムディレクトリの一部（documents、resource、temp など）の絶対パスを取得できます。これらのファイルの絶対パスを取得したら、io.* 関数と os.* 関数を使ってファイルにアクセスできます（上記参照）。

拡張機能

Asset Portal には、ファイルやフォルダーへのアクセスを簡単にするアセットがいくつかあります。次に例を示します。

• Lua File System (LFS) - ディレクトリ、ファイルの権限などを操作する関数です。
• DefSave - セッション間で設定やプレイヤーデータを保存、読み込みするためのモジュールです。