GFStorageBackend¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/storage/gf_storage_backend.gd - 模块：
Standard - 继承：
RefCounted - API：
public - 类别：协议与扩展点 (
protocol) - 首次版本：
3.17.0
存储后端扩展接口。 该类只定义通用后端协议，不绑定本地、云、平台 SDK 或同步策略。 默认实现返回不可用结果；项目可继承它并由自定义 Utility 或派生的 GFStorageUtility 组合使用。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 方法 | initialize |
func initialize(config: Dictionary = {}) -> Error: |
| 方法 | shutdown |
func shutdown() -> void: |
| 方法 | save_data |
func save_data(file_name: String, data: Dictionary, metadata: Dictionary = {}) -> Error: |
| 方法 | load_data |
func load_data(file_name: String) -> Dictionary: |
| 方法 | delete_data |
func delete_data(file_name: String) -> Error: |
| 方法 | has_data |
func has_data(file_name: String) -> bool: |
| 方法 | list_data |
func list_data() -> Array[Dictionary]: |
| 方法 | get_capabilities |
func get_capabilities() -> Dictionary: |
| 方法 | _initialize |
func _initialize(_config: Dictionary) -> Error: |
| 方法 | _shutdown |
func _shutdown() -> void: |
| 方法 | _save_data |
func _save_data(_file_name: String, _data: Dictionary, _metadata: Dictionary) -> Error: |
| 方法 | _load_data |
func _load_data(_file_name: String) -> Dictionary: |
| 方法 | _delete_data |
func _delete_data(_file_name: String) -> Error: |
| 方法 | _has_data |
func _has_data(_file_name: String) -> bool: |
| 方法 | _list_data |
func _list_data() -> Array[Dictionary]: |
| 方法 | _get_capabilities |
func _get_capabilities() -> Dictionary: |
方法¶
initialize¶
- API：
public
初始化后端。
参数：
| 名称 | 说明 |
|---|---|
config |
后端配置字典。 |
返回：Godot Error 结果码。
结构：
config: Dictionary，包含后端特定的初始化选项。
shutdown¶
- API：
public
关闭后端并释放资源。
save_data¶
- API：
public
保存纯字典数据。
参数：
| 名称 | 说明 |
|---|---|
file_name |
逻辑文件名。 |
data |
要保存的数据。 |
metadata |
可选元数据。 |
返回：Godot Error 结果码。
结构：
data: Dictionary，存储后端持有的数据载荷。metadata: Dictionary，包含时间戳或修订号等后端特定元数据。
load_data¶
- API：
public
读取纯字典数据。
参数：
| 名称 | 说明 |
|---|---|
file_name |
逻辑文件名。 |
返回：结果字典，包含 ok、data、metadata、error。
结构：
return: Dictionary，包含 ok: bool、data: Dictionary、metadata: Dictionary 和 error: String。
delete_data¶
- API：
public
删除纯字典数据。
参数：
| 名称 | 说明 |
|---|---|
file_name |
逻辑文件名。 |
返回：Godot Error 结果码。
has_data¶
- API：
public
判断逻辑文件是否存在。
参数：
| 名称 | 说明 |
|---|---|
file_name |
逻辑文件名。 |
返回：存在时返回 true。
list_data¶
- API：
public
枚举后端中的逻辑文件。
返回：文件摘要数组。
结构：
return: Array，包含 file_name: String 和可选 metadata: Dictionary 的 Dictionary 条目。
get_capabilities¶
- API：
public
获取后端能力描述。
返回：能力字典副本。
结构：
return: Dictionary，包含 read、write、delete、list 和 sync 布尔能力标记。
_initialize¶
- API：
protected
初始化具体后端。
参数：
| 名称 | 说明 |
|---|---|
_config |
后端配置字典。 |
返回：Godot Error 结果码。
结构：
_config: Dictionary，包含后端特定的初始化选项。
_shutdown¶
- API：
protected
释放具体后端持有的资源。
_save_data¶
- API：
protected
保存纯字典数据到具体后端。
参数：
| 名称 | 说明 |
|---|---|
_file_name |
逻辑文件名。 |
_data |
要保存的数据副本。 |
_metadata |
可选元数据副本。 |
返回：Godot Error 结果码。
结构：
_data: Dictionary，存储后端持有的数据载荷。_metadata: Dictionary，包含时间戳或修订号等后端特定元数据。
_load_data¶
- API：
protected
从具体后端读取纯字典数据。
参数：
| 名称 | 说明 |
|---|---|
_file_name |
逻辑文件名。 |
返回：结果字典，包含 ok、data、metadata、error。
结构：
return: Dictionary，包含 ok: bool、data: Dictionary、metadata: Dictionary 和 error: String。
_delete_data¶
- API：
protected
从具体后端删除纯字典数据。
参数：
| 名称 | 说明 |
|---|---|
_file_name |
逻辑文件名。 |
返回：Godot Error 结果码。
_has_data¶
- API：
protected
判断具体后端是否存在逻辑文件。
参数：
| 名称 | 说明 |
|---|---|
_file_name |
逻辑文件名。 |
返回：存在时返回 true。
_list_data¶
- API：
protected
枚举具体后端中的逻辑文件。
返回：文件摘要数组。
结构：
return: Array，包含 file_name: String 和可选 metadata: Dictionary 的 Dictionary 条目。
_get_capabilities¶
- API：
protected
获取具体后端能力描述。
返回：能力字典。
结构：
return: Dictionary，包含 read、write、delete、list 和 sync 布尔能力标记。