GFPlatformLocaleMap¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/text/gf_platform_locale_map.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
8.0.0
平台语言键到 Godot locale 的映射表。 该资源用于让 Steam、微信、主机平台或自建启动器等 adapter 把自身语言键转换为 Godot TranslationServer 使用的 locale。GF 不内置任何具体平台表。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | entries |
var entries: Array[Dictionary] = [] |
| 属性 | default_locale |
var default_locale: String = "" |
| 方法 | set_mapping |
func set_mapping( platform_id: StringName, platform_locale: String, locale: String, fallback_locale: String = "", display_name: String = "" ) -> Dictionary: |
| 方法 | get_mapping |
func get_mapping(platform_id: StringName, platform_locale: String) -> Dictionary: |
| 方法 | map_locale |
func map_locale(platform_id: StringName, platform_locale: String, fallback_value: String = "") -> String: |
| 方法 | map_fallback_locale |
func map_fallback_locale(platform_id: StringName, platform_locale: String, fallback_value: String = "") -> String: |
| 方法 | erase_mapping |
func erase_mapping(platform_id: StringName, platform_locale: String) -> bool: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_map |
func duplicate_map() -> GFPlatformLocaleMap: |
| 方法 | make_entry |
static func make_entry( platform_id: StringName, platform_locale: String, locale: String, fallback_locale: String = "", display_name: String = "" ) -> Dictionary: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFPlatformLocaleMap: |
属性¶
entries¶
- API：
public - 首次版本：
8.0.0
映射表条目。
结构：
entries: Array[Dictionary]，每项包含 platform_id、platform_locale、locale、fallback_locale 和 display_name。
default_locale¶
- API：
public - 首次版本：
8.0.0
未命中时返回的默认 locale。
方法¶
set_mapping¶
- API：
public - 首次版本：
8.0.0
func set_mapping( platform_id: StringName, platform_locale: String, locale: String, fallback_locale: String = "", display_name: String = "" ) -> Dictionary:
设置或替换映射条目。
参数：
| 名称 | 说明 |
|---|---|
platform_id |
平台标识。 |
platform_locale |
平台语言键。 |
locale |
Godot locale。 |
fallback_locale |
fallback Godot locale。 |
display_name |
展示名。 |
返回：写入后的条目副本。
结构：
return: Dictionary locale mapping entry.
get_mapping¶
- API：
public - 首次版本：
8.0.0
获取映射条目。
参数：
| 名称 | 说明 |
|---|---|
platform_id |
平台标识。 |
platform_locale |
平台语言键。 |
返回：映射条目副本；不存在时为空字典。
结构：
return: Dictionary locale mapping entry.
map_locale¶
- API：
public - 首次版本：
8.0.0
func map_locale(platform_id: StringName, platform_locale: String, fallback_value: String = "") -> String:
映射到 Godot locale。
参数：
| 名称 | 说明 |
|---|---|
platform_id |
平台标识。 |
platform_locale |
平台语言键。 |
fallback_value |
未命中时的调用方 fallback。 |
返回：Godot locale。
map_fallback_locale¶
- API：
public - 首次版本：
8.0.0
func map_fallback_locale(platform_id: StringName, platform_locale: String, fallback_value: String = "") -> String:
映射到 fallback Godot locale。
参数：
| 名称 | 说明 |
|---|---|
platform_id |
平台标识。 |
platform_locale |
平台语言键。 |
fallback_value |
未命中时的调用方 fallback。 |
返回：fallback Godot locale。
erase_mapping¶
- API：
public - 首次版本：
8.0.0
移除映射条目。
参数：
| 名称 | 说明 |
|---|---|
platform_id |
平台标识。 |
platform_locale |
平台语言键。 |
返回：找到并移除时返回 true。
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：映射表字典。
结构：
return: Dictionary with entries and default_locale.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用映射表。
参数：
| 名称 | 说明 |
|---|---|
data |
映射表字典。 |
结构：
data: Dictionary with entries and default_locale.
duplicate_map¶
- API：
public - 首次版本：
8.0.0
创建映射表深拷贝。
返回：新映射表。
make_entry¶
- API：
public - 首次版本：
8.0.0
static func make_entry( platform_id: StringName, platform_locale: String, locale: String, fallback_locale: String = "", display_name: String = "" ) -> Dictionary:
创建映射条目。
参数：
| 名称 | 说明 |
|---|---|
platform_id |
平台标识。 |
platform_locale |
平台语言键。 |
locale |
Godot locale。 |
fallback_locale |
fallback Godot locale。 |
display_name |
展示名。 |
返回：映射条目。
结构：
return: Dictionary locale mapping entry.
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建映射表。
参数：
| 名称 | 说明 |
|---|---|
data |
映射表字典。 |
返回：新映射表。
结构：
data: Dictionary with entries and default_locale.