Texts
Backend interface for text file loading operations.
This interface handles loading text files from various sources. Text files are loaded as UTF-8 encoded strings and include any file type marked as text by the backend (txt, json, xml, etc.).
The interface is separate from Binaries to allow backends to optimize text handling differently from binary data, such as applying text-specific caching or encoding conversions.
Used by the TextAsset class and other systems that need text file access.
Instance Members
load(path: String, ?options: Null<backend.LoadTextOptions>, done: Function): VoidLoads a text file from the specified path.
The file is loaded as a UTF-8 string. The path is relative to the assets directory unless it's an absolute path or URL.
| Name | Type | Default | Description |
|---|---|---|---|
path |
String | The path to the text file to load | |
options |
Null<backend.LoadTextOptions> | (optional) | Optional loading configuration (caching, hot-reload, etc.) |
done |
Function | Callback invoked with the loaded text content or null on failure |
supportsHotReloadPath(): BoolChecks if the backend supports hot-reloading of text files.
When true, files can include a ?hot=timestamp query parameter to
bypass caching and force reloading when the file changes during development.
This is particularly useful for configuration files and data that changes
frequently during development.
| Returns | Description |
|---|---|
| Bool | True if hot-reload paths are supported, false otherwise |