GFSubscriptionToken¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/core/gf_subscription_token.gd - 模块：
Kernel - 继承：
RefCounted - API：
public - 类别：运行时句柄 (
runtime_handle) - 首次版本：
8.0.0
可取消订阅的通用运行时句柄。 订阅创建方应返回该句柄，由调用方在不再需要监听时调用 cancel()。 cancel() 是幂等的，首次取消会执行注册的清理回调，后续调用只返回 false。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 方法 | _init |
func _init(cancel_callback: Callable = Callable(), debug_label: String = "") -> void: |
| 方法 | cancel |
func cancel() -> bool: |
| 方法 | is_active |
func is_active() -> bool: |
| 方法 | get_debug_label |
func get_debug_label() -> String: |
方法¶
_init¶
- API：
public - 首次版本：
8.0.0
构造函数。
参数：
| 名称 | 说明 |
|---|---|
cancel_callback |
首次取消时执行的无参清理回调。 |
debug_label |
可选诊断标签。 |
cancel¶
- API：
public - 首次版本：
8.0.0
取消订阅并执行清理回调。
返回：本次调用是否首次取消了活动订阅。
is_active¶
- API：
public - 首次版本：
8.0.0
返回订阅是否仍处于活动状态。
返回：活动时返回 true。
get_debug_label¶
- API：
public - 首次版本：
8.0.0
返回诊断标签。
返回：创建订阅时传入的诊断标签。