オンライン サービスの User File インターフェース では、ランタイム時にプラットフォームのバックエンドのオンライン サービスからユーザー固有のファイルを読み取るためのサポートをゲームに提供します。
ゲームでは、タイトルにパッケージされていないユーザー ファイルを読み取る必要がある場合があります。たとえば、コンフィギュレーション ファイルやユーザー固有のゲームのセーブ ファイルなどです。このインターフェースは、ランタイム時に使用するこれらのファイルにアクセスし、ダウンロードするうえで役立ちます。
タイトル固有のファイル ストレージについては、「Title File インターフェース」を参照してください。
API の概要
関数
次の表は、User File インターフェースによって提供される関数の概要です。
| 関数 | 説明 |
|---|---|
EnumerateFiles |
利用可能なファイルをすべて列挙します。 |
GetEnumeratedFiles |
EnumerateFiles の呼び出しによって列挙されたファイルのキャッシュされたリストを取得します。 |
ReadFile |
ファイルを読み取り、その内容を返します。 |
WriteFile |
ファイルの内容を、指定された名前のファイルに書き込みます。 |
CopyFile |
ファイルの内容を別のファイルにコピーします。 |
DeleteFile |
ファイルを削除します。 |
ファイル読み取りのプロセス フロー
User File インターフェースを使用して、バックエンドのオンライン サービスからのファイルの読み取り、コピー、または削除を行うには、次の手順を実行します。
EnumerateFilesは、オンライン サービスから取得可能なすべてのファイルのリストをインターフェースでキャッシュします。GetEnumeratedFilesは、EnumerateFilesによってインターフェースでキャッシュされたファイルのリストを取得します。ReadFileは、取得したリストのファイルごとに、ファイルを読み取り、その内容を返します。
ファイルを変更する
User File インターフェースは、次のファイル変更操作もサポートしています。
WriteFileは、新しいファイルを作成したり、既存のファイルを上書きしたりします。CopyFileは、ユーザー ファイルの内容を別のユーザー ファイルにコピーします。DeleteFileは、指定された名前のユーザー ファイルを、バックエンドのオンライン サービスから削除します。
詳細情報
ヘッダ ファイル
詳細については、必要に応じて、「UserFile.h」ヘッダ ファイルを直接確認してください。User File インターフェースのヘッダ ファイル「UserFile.h」は、次のディレクトリに格納されています。
UNREAL_ENGINE_ROOT\Engine\Plugins\Online\OnlineServices\Source\OnlineServicesInterface\Public\Online
UE のソース コードの入手手順については、「Unreal Engine のソース コードをダウンロードする」を参照してください。
関数パラメータおよび戻り型
パラメータの渡し方や関数が返すときの結果の処理を含む、関数のパラメータと戻り型については、「Online Services の概要」ページの「関数」セクションを参照してください。