GFPlatformRuntimeContext¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/platform/gf_platform_runtime_context.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
8.0.0
平台运行时上下文。 聚合平台标识、adapter 标识、能力集合、显示信息、存储根和启动参数。该资源只 记录 adapter 提供的事实，不调用 SDK、不执行登录、不创建网络连接。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | platform_id |
var platform_id: StringName = &"" |
| 属性 | adapter_id |
var adapter_id: StringName = &"" |
| 属性 | display_name |
var display_name: String = "" |
| 属性 | capabilities |
var capabilities: GFPlatformCapabilitySet = GFPlatformCapabilitySet.new() |
| 属性 | locale |
var locale: String = "" |
| 属性 | fallback_locale |
var fallback_locale: String = "" |
| 属性 | pixel_ratio |
var pixel_ratio: float = 1.0 |
| 属性 | window_size |
var window_size: Vector2i = Vector2i.ZERO |
| 属性 | screen_size |
var screen_size: Vector2i = Vector2i.ZERO |
| 属性 | safe_area |
var safe_area: Rect2i = Rect2i() |
| 属性 | storage_roots |
var storage_roots: Dictionary = {} |
| 属性 | launch_options |
var launch_options: Dictionary = {} |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | configure |
func configure(p_platform_id: StringName, options: Dictionary = {}) -> GFPlatformRuntimeContext: |
| 方法 | set_capabilities |
func set_capabilities(p_capabilities: GFPlatformCapabilitySet) -> GFPlatformRuntimeContext: |
| 方法 | add_capability |
func add_capability(capability_id: StringName, capability_limits: Dictionary = {}) -> bool: |
| 方法 | has_capability |
func has_capability(capability_id: StringName) -> bool: |
| 方法 | set_window_info |
func set_window_info( p_window_size: Vector2i, p_screen_size: Vector2i = Vector2i.ZERO, p_pixel_ratio: float = 1.0, p_safe_area: Rect2i = Rect2i() ) -> GFPlatformRuntimeContext: |
| 方法 | set_storage_root |
func set_storage_root(root_id: StringName, root_path: String) -> bool: |
| 方法 | get_storage_root |
func get_storage_root(root_id: StringName, default_value: String = "") -> String: |
| 方法 | erase_storage_root |
func erase_storage_root(root_id: StringName) -> bool: |
| 方法 | make_compatibility_profile |
func make_compatibility_profile(profile_id: StringName = &"") -> GFCompatibilityProfile: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_context |
func duplicate_context() -> GFPlatformRuntimeContext: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFPlatformRuntimeContext: |
属性¶
platform_id¶
- API：
public - 首次版本：
8.0.0
平台标识。
adapter_id¶
- API：
public - 首次版本：
8.0.0
Adapter 标识。
display_name¶
- API：
public - 首次版本：
8.0.0
平台展示名。
capabilities¶
- API：
public - 首次版本：
8.0.0
能力集合。
locale¶
- API：
public - 首次版本：
8.0.0
Godot locale。
fallback_locale¶
- API：
public - 首次版本：
8.0.0
fallback Godot locale。
pixel_ratio¶
- API：
public - 首次版本：
8.0.0
平台像素比。
window_size¶
- API：
public - 首次版本：
8.0.0
逻辑窗口尺寸。
screen_size¶
- API：
public - 首次版本：
8.0.0
物理屏幕尺寸。
safe_area¶
- API：
public - 首次版本：
8.0.0
平台安全区域。
storage_roots¶
- API：
public - 首次版本：
8.0.0
逻辑存储根映射。
结构：
storage_roots: Dictionary[String, String]，key 为逻辑 root_id。
launch_options¶
- API：
public - 首次版本：
8.0.0
启动参数。
结构：
launch_options: Dictionary adapter-defined launch options.
metadata¶
- API：
public - 首次版本：
8.0.0
调用方元数据。
结构：
metadata: Dictionary caller-defined runtime metadata.
方法¶
configure¶
- API：
public - 首次版本：
8.0.0
配置运行时上下文。
参数：
| 名称 | 说明 |
|---|---|
p_platform_id |
平台标识。 |
options |
上下文选项。 |
返回：当前上下文。
结构：
options: Dictionary，可包含 adapter_id、display_name、locale、fallback_locale、capabilities、capability_ids、window_size、screen_size、safe_area、pixel_ratio、storage_roots、launch_options 和 metadata。
set_capabilities¶
- API：
public - 首次版本：
8.0.0
设置能力集合。
参数：
| 名称 | 说明 |
|---|---|
p_capabilities |
能力集合。 |
返回：当前上下文。
add_capability¶
- API：
public - 首次版本：
8.0.0
添加能力。
参数：
| 名称 | 说明 |
|---|---|
capability_id |
能力 ID。 |
capability_limits |
能力限制字段。 |
返回：成功添加或已存在时返回 true。
结构：
capability_limits: Dictionary capability limits.
has_capability¶
- API：
public - 首次版本：
8.0.0
检查能力是否存在。
参数：
| 名称 | 说明 |
|---|---|
capability_id |
能力 ID。 |
返回：存在返回 true。
set_window_info¶
- API：
public - 首次版本：
8.0.0
func set_window_info( p_window_size: Vector2i, p_screen_size: Vector2i = Vector2i.ZERO, p_pixel_ratio: float = 1.0, p_safe_area: Rect2i = Rect2i() ) -> GFPlatformRuntimeContext:
设置窗口与显示信息。
参数：
| 名称 | 说明 |
|---|---|
p_window_size |
逻辑窗口尺寸。 |
p_screen_size |
物理屏幕尺寸。 |
p_pixel_ratio |
平台像素比。 |
p_safe_area |
平台安全区域。 |
返回：当前上下文。
set_storage_root¶
- API：
public - 首次版本：
8.0.0
设置逻辑存储根路径。
参数：
| 名称 | 说明 |
|---|---|
root_id |
逻辑 root ID。 |
root_path |
平台路径。 |
返回：写入成功返回 true。
get_storage_root¶
- API：
public - 首次版本：
8.0.0
读取逻辑存储根路径。
参数：
| 名称 | 说明 |
|---|---|
root_id |
逻辑 root ID。 |
default_value |
缺失时返回的默认路径。 |
返回：平台路径。
erase_storage_root¶
- API：
public - 首次版本：
8.0.0
移除逻辑存储根路径。
参数：
| 名称 | 说明 |
|---|---|
root_id |
逻辑 root ID。 |
返回：找到并移除时返回 true。
make_compatibility_profile¶
- API：
public - 首次版本：
8.0.0
创建兼容性 Profile。
参数：
| 名称 | 说明 |
|---|---|
profile_id |
Profile ID；为空时使用 platform_id。 |
返回：兼容性 Profile。
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：平台上下文字典。
结构：
return: Dictionary platform runtime context.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用平台上下文字段。
参数：
| 名称 | 说明 |
|---|---|
data |
平台上下文字典。 |
结构：
data: Dictionary platform runtime context.
duplicate_context¶
- API：
public - 首次版本：
8.0.0
创建运行时上下文深拷贝。
返回：新运行时上下文。
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建运行时上下文。
参数：
| 名称 | 说明 |
|---|---|
data |
平台上下文字典。 |
返回：新运行时上下文。
结构：
data: Dictionary platform runtime context.