Mit Dateien arbeiten

Es gibt viele verschiedene Möglichkeiten, Dateien zu erstellen und/oder auf sie zuzugreifen. Die Dateipfade und die Art des Zugriffs unterscheiden sich je nach Dateityp und Speicherort der Datei.

Funktionen für den Zugriff auf Dateien und Ordner

Defold bietet verschiedene Funktionen für die Arbeit mit Dateien:

• Du kannst die standardmäßigen io.*-Funktionen verwenden, um Dateien zu lesen und zu schreiben. Mit diesen Funktionen kannst du den gesamten Ein-/Ausgabeprozess sehr genau steuern.

-- 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

• Du kannst os.rename() und os.remove() verwenden, um Dateien umzubenennen und zu löschen.

• Du kannst sys.save() und sys.load() verwenden, um Lua-Tabellen zu lesen und zu schreiben. Weitere sys.*-Funktionen helfen dabei, Dateipfade plattformunabhängig zu ermitteln.

-- 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() gibt eine leere Tabelle zurück, wenn die Datei nicht existiert. Wenn die Datei existiert, aber nicht mit sys.save() erstellt wurde, beschädigt ist oder ein nicht unterstütztes Format für serialisierte Tabellen verwendet, löst sys.load() einen Lua-Fehler aus. Verwende wie oben gezeigt pcall(), wenn die Anwendung Fehler durch beschädigte oder extern veränderte Speicherdaten abfangen können muss.

Speicherorte von Dateien und Ordnern

Die Speicherorte von Dateien und Ordnern lassen sich in drei Kategorien einteilen:

• Anwendungsspezifische Dateien, die deine Anwendung erstellt
• Dateien und Ordner, die mit deiner Anwendung gebündelt werden
• Systemspezifische Dateien, auf die deine Anwendung zugreift

Anwendungsspezifische Dateien speichern und laden

Es wird empfohlen, anwendungsspezifische Dateien wie Höchstpunktzahlen, Benutzereinstellungen und den Spielzustand an einem Speicherort zu speichern und zu laden, den das Betriebssystem eigens für diesen Zweck bereitstellt. Mit sys.get_save_file() kannst du den betriebssystemspezifischen absoluten Pfad zu einer Datei ermitteln. Sobald du den absoluten Pfad hast, kannst du die Funktionen sys.*, io.* und os.* verwenden (siehe oben).

Sieh dir das Beispiel zur Verwendung von sys.save() und sys.load() an.

Auf Dateien zugreifen, die mit der Anwendung gebündelt sind

Mit Bundle-Ressourcen (bundle resources) und benutzerdefinierten Ressourcen (custom resources) kannst du Dateien in deine Anwendung aufnehmen.

Benutzerdefinierte Ressourcen

Benutzerdefinierte Ressourcen (custom resources) werden über das Feld Custom Resources in game.project in das Hauptarchiv des Spiels aufgenommen.

Das Feld Custom Resources sollte eine durch Kommas getrennte Liste der Ressourcen enthalten, die in das Hauptarchiv des Spiels aufgenommen werden. Wenn Verzeichnisse angegeben sind, werden alle Dateien und Verzeichnisse im jeweiligen Verzeichnis rekursiv aufgenommen. Du kannst die Dateien mit sys.load_resource() lesen.

Erweiterungen können diese Dateien auch über ext.properties bereitstellen. Ihre Pfade werden sowohl bei Editor-Builds als auch bei Bob-Archiven mit den benutzerdefinierten Ressourcen des Projekts zusammengeführt. Siehe benutzerdefinierte Ressourcen von Erweiterungen.

-- 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-Ressourcen

Bundle-Ressourcen (bundle resources) sind zusätzliche Dateien und Ordner, die du über das Feld Bundle Resources in game.project in das Bundle deiner Anwendung aufnimmst.

Das Feld Bundle Resources sollte eine durch Kommas getrennte Liste von Verzeichnissen enthalten. In diesen Verzeichnissen liegen die Ressourcendateien und Ordner, die bei der Bundle-Erstellung unverändert in das resultierende Paket kopiert werden sollen. Die Verzeichnisse müssen mit einem absoluten Pfad vom Projektstamm aus angegeben werden, zum Beispiel /res. Das Ressourcenverzeichnis muss Unterordner enthalten, die nach dem Schema platform oder architecture-platform benannt sind.

Unterstützte Plattformen sind ios, android, osx, win32, linux, web, switch. Ein Unterordner namens common ist ebenfalls zulässig und enthält Ressourcendateien, die für alle Plattformen gemeinsam verwendet werden. Beispiel:

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

Du kannst sys.get_application_path() verwenden, um den Pfad zu ermitteln, unter dem die Anwendung gespeichert ist. Verwende diesen Basispfad der Anwendung, um den vollständigen absoluten Pfad zu den Dateien zu bilden, auf die du zugreifen musst. Sobald du den absoluten Pfad dieser Dateien hast, kannst du mit den Funktionen io.* und os.* auf die Dateien zugreifen.

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)

Benutzerdefinierte Ressourcen und Bundle-Ressourcen – Vergleich

Zugriff auf Systemdateien

Das Betriebssystem kann den Zugriff auf Systemdateien aus Sicherheitsgründen einschränken. Mit der nativen Erweiterung (native extension) extension-directories kannst du den absoluten Pfad zu einigen gängigen Systemverzeichnissen ermitteln (z. B. documents, resource, temp). Sobald du den absoluten Pfad dieser Dateien hast, kannst du mit den Funktionen io.* und os.* auf die Dateien zugreifen (siehe oben).

Erweiterungen

Das Asset Portal enthält verschiedene Assets, die den Zugriff auf Dateien und Ordner vereinfachen. Einige Beispiele:

• Lua File System (LFS) - Funktionen für die Arbeit mit Verzeichnissen, Dateiberechtigungen usw.
• DefSave - Ein Modul, mit dem du Konfigurations- und Spielerdaten über Sitzungen hinweg speichern und laden kannst.