The Online Services Title File Interface provides support for your game to read files from your platform's backend online services at runtime.
Your game might require reading files not packaged with your title. The title file interface provides you with tools to read files that you have uploaded to backend online services. Examples of such information might include configuration files or a message of the day. This interface helps you to access and download these files for use at runtime.
For player-specific file storage, see the User File Interface.
API Overview
Functions
The following table provides a high-level overview of the functions provided by the Title File Interface:
| Function | Description |
|---|---|
Enumerate all available files. | |
Retrieve a cached list of files enumerated by a call to | |
Read a file and return its contents. |
Process Flow
To read a file from the backend online services with the Title File Interface, follow these steps:
EnumerateFilesasynchronously caches a list of all files available to retrieve from the online services with the interface.GetEnumeratedFilesretrieves the list of files cached with the interface byEnumerateFiles.For each file in the retrieved list,
ReadFilereads the file asynchronously and returns its contents for use in your game.
More Information
Header File
Consult the TitleFile.h header file directly for more information as needed. The Title File Interface header file TitleFile.h is located in the directory:
Engine\Plugins\Online\OnlineServices\Source\OnlineServicesInterface\Public\OnlineFor instructions on how to obtain the UE source code, see our documentation on Downloading Unreal Engine Source Code.
Function Parameters and Return Types
See the Functions section of the Online Services Overview page for an explanation of function parameters and return types, including how to pass parameters and processing the results when functions return.