GFShakeReceiver2D¶
API Reference / Feedback / 类索引
- 路径：
addons/gf/extensions/feedback/nodes/gf_shake_receiver_2d.gd - 模块：
Feedback - 继承：
Node - API：
public - 类别：运行时句柄 (
runtime_handle) - 首次版本：
3.17.0
将反馈采样应用到 Node2D 的通用接收器。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | target_path |
var target_path: NodePath = NodePath("") |
| 属性 | channel |
var channel: StringName = &"default" |
| 属性 | apply_position |
var apply_position: bool = true |
| 属性 | apply_rotation |
var apply_rotation: bool = true |
| 属性 | apply_scale |
var apply_scale: bool = false |
| 属性 | capture_on_ready |
var capture_on_ready: bool = true |
| 属性 | restore_on_exit |
var restore_on_exit: bool = true |
| 属性 | utility |
var utility: GFShakeUtility = null |
| 方法 | set_utility |
func set_utility(shake_utility: GFShakeUtility) -> void: |
| 方法 | get_target |
func get_target() -> Node2D: |
| 方法 | capture_base_transform |
func capture_base_transform() -> bool: |
| 方法 | apply_current_sample |
func apply_current_sample() -> bool: |
| 方法 | reset_to_base |
func reset_to_base() -> bool: |
属性¶
target_path¶
- API：
public
目标 Node2D 路径；为空时优先使用自身，其次使用父节点。
channel¶
- API：
public
采样 channel。
apply_position¶
- API：
public
是否应用 position 偏移。
apply_rotation¶
- API：
public
是否应用 rotation_degrees 偏移。
apply_scale¶
- API：
public
是否应用 scale 偏移。
capture_on_ready¶
- API：
public
ready 时是否记录基础变换。
restore_on_exit¶
- API：
public
退出树时是否恢复基础变换。
utility¶
- API：
public
可选反馈工具实例；为空时从全局架构查询。
方法¶
set_utility¶
- API：
public
设置反馈工具实例。
参数：
| 名称 | 说明 |
|---|---|
shake_utility |
反馈工具实例。 |
get_target¶
- API：
public
获取当前目标节点。
返回：目标 Node2D；不存在时返回 null。
capture_base_transform¶
- API：
public
记录当前目标基础变换。
返回：记录成功返回 true。
apply_current_sample¶
- API：
public
应用当前 channel 采样。
返回：应用成功返回 true。
reset_to_base¶
- API：
public
恢复目标基础变换。
返回：恢复成功返回 true。