GFPlatformLifecycleEvent¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/platform/gf_platform_lifecycle_event.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
8.0.0
平台生命周期事件。 用纯数据表达平台 adapter 观察到的前后台、窗口、网络、输入法或资源压力等事件。 它不订阅任何平台回调，也不持有场景树状态。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 常量 | TYPE_FOREGROUND |
const TYPE_FOREGROUND: StringName = &"foreground" |
| 常量 | TYPE_BACKGROUND |
const TYPE_BACKGROUND: StringName = &"background" |
| 常量 | TYPE_WINDOW_RESIZED |
const TYPE_WINDOW_RESIZED: StringName = &"window_resized" |
| 常量 | TYPE_SAFE_AREA_CHANGED |
const TYPE_SAFE_AREA_CHANGED: StringName = &"safe_area_changed" |
| 常量 | TYPE_NETWORK_CHANGED |
const TYPE_NETWORK_CHANGED: StringName = &"network_changed" |
| 常量 | TYPE_KEYBOARD_SHOWN |
const TYPE_KEYBOARD_SHOWN: StringName = &"keyboard_shown" |
| 常量 | TYPE_KEYBOARD_HIDDEN |
const TYPE_KEYBOARD_HIDDEN: StringName = &"keyboard_hidden" |
| 常量 | TYPE_MEMORY_WARNING |
const TYPE_MEMORY_WARNING: StringName = &"memory_warning" |
| 属性 | event_type |
var event_type: StringName = &"" |
| 属性 | platform_id |
var platform_id: StringName = &"" |
| 属性 | sequence |
var sequence: int = 0 |
| 属性 | timestamp_msec |
var timestamp_msec: int = 0 |
| 属性 | payload |
var payload: Dictionary = {} |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | configure |
func configure( p_event_type: StringName, p_platform_id: StringName = &"", p_payload: Dictionary = {}, p_sequence: int = 0, p_timestamp_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformLifecycleEvent: |
| 方法 | is_type |
func is_type(expected_type: StringName) -> bool: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_event |
func duplicate_event() -> GFPlatformLifecycleEvent: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFPlatformLifecycleEvent: |
常量¶
TYPE_FOREGROUND¶
- API：
public - 首次版本：
8.0.0
平台进入前台或恢复可交互。
TYPE_BACKGROUND¶
- API：
public - 首次版本：
8.0.0
平台进入后台、挂起或不可交互。
TYPE_WINDOW_RESIZED¶
- API：
public - 首次版本：
8.0.0
窗口尺寸或显示区域变化。
TYPE_SAFE_AREA_CHANGED¶
- API：
public - 首次版本：
8.0.0
安全区域变化。
TYPE_NETWORK_CHANGED¶
- API：
public - 首次版本：
8.0.0
网络状态变化。
TYPE_KEYBOARD_SHOWN¶
- API：
public - 首次版本：
8.0.0
输入法或软键盘显示。
TYPE_KEYBOARD_HIDDEN¶
- API：
public - 首次版本：
8.0.0
输入法或软键盘隐藏。
TYPE_MEMORY_WARNING¶
- API：
public - 首次版本：
8.0.0
平台发出内存压力警告。
属性¶
event_type¶
- API：
public - 首次版本：
8.0.0
事件类型。
platform_id¶
- API：
public - 首次版本：
8.0.0
平台标识。
sequence¶
- API：
public - 首次版本：
8.0.0
单调递增序号。
timestamp_msec¶
- API：
public - 首次版本：
8.0.0
事件时间戳，单位毫秒。
payload¶
- API：
public - 首次版本：
8.0.0
事件载荷。
结构：
payload: Dictionary adapter-defined event payload.
metadata¶
- API：
public - 首次版本：
8.0.0
调用方元数据。
结构：
metadata: Dictionary caller-defined metadata.
方法¶
configure¶
- API：
public - 首次版本：
8.0.0
func configure( p_event_type: StringName, p_platform_id: StringName = &"", p_payload: Dictionary = {}, p_sequence: int = 0, p_timestamp_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformLifecycleEvent:
配置生命周期事件。
参数：
| 名称 | 说明 |
|---|---|
p_event_type |
事件类型。 |
p_platform_id |
平台标识。 |
p_payload |
事件载荷。 |
p_sequence |
单调递增序号。 |
p_timestamp_msec |
时间戳；小于等于 0 时使用 Time.get_ticks_msec()。 |
p_metadata |
调用方元数据。 |
返回：当前事件。
结构：
p_payload: Dictionary adapter-defined event payload.p_metadata: Dictionary caller-defined metadata.
is_type¶
- API：
public - 首次版本：
8.0.0
检查事件类型。
参数：
| 名称 | 说明 |
|---|---|
expected_type |
期望事件类型。 |
返回：类型一致返回 true。
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：生命周期事件字典。
结构：
return: Dictionary with event_type, platform_id, sequence, timestamp_msec, payload, and metadata.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用生命周期事件字段。
参数：
| 名称 | 说明 |
|---|---|
data |
生命周期事件字典。 |
结构：
data: Dictionary with event_type, platform_id, sequence, timestamp_msec, payload, and metadata.
duplicate_event¶
- API：
public - 首次版本：
8.0.0
创建生命周期事件深拷贝。
返回：新生命周期事件。
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建生命周期事件。
参数：
| 名称 | 说明 |
|---|---|
data |
生命周期事件字典。 |
返回：新生命周期事件。
结构：
data: Dictionary with event_type, platform_id, sequence, timestamp_msec, payload, and metadata.