GFHurtBox2D¶
API Reference / Combat / 类索引
- 路径：
addons/gf/extensions/combat/hit_detection/gf_hurt_box_2d.gd - 模块：
Combat - 继承：
Area2D - API：
public - 类别：运行时句柄 (
runtime_handle) - 首次版本：
3.17.0
2D 通用命中接收区域。 节点只过滤和接收 GFCombatHitContext，不直接修改生命、属性或 Buff。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 信号 | hit_validating |
signal hit_validating(context: GFCombatHitContext, report: Dictionary) |
| 信号 | hit_received |
signal hit_received(context: GFCombatHitContext, report: Dictionary) |
| 信号 | hit_rejected |
signal hit_rejected(context: GFCombatHitContext, report: Dictionary) |
| 信号 | enabled_changed |
signal enabled_changed(enabled: bool) |
| 属性 | enabled |
var enabled: bool = true: |
| 属性 | accepted_hit_ids |
var accepted_hit_ids: Array[StringName] = [] |
| 属性 | rejected_hit_ids |
var rejected_hit_ids: Array[StringName] = [] |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 属性 | receiver_path |
var receiver_path: NodePath = NodePath("") |
| 属性 | collision_shape_config |
var collision_shape_config: GFHitCollisionShapeConfig2D = null: |
| 属性 | collision_shape_configs |
var collision_shape_configs: Array[GFHitCollisionShapeConfig2D] = []: |
| 属性 | auto_apply_collision_shape_config |
var auto_apply_collision_shape_config: bool = true |
| 属性 | validation_callback |
var validation_callback: Callable = Callable() |
| 方法 | apply_collision_shape_config |
func apply_collision_shape_config(config: GFHitCollisionShapeConfig2D = null) -> CollisionShape2D: |
| 方法 | apply_collision_shape_configs |
func apply_collision_shape_configs(configs: Array[GFHitCollisionShapeConfig2D] = []) -> Array[CollisionShape2D]: |
| 方法 | get_generated_collision_shape |
func get_generated_collision_shape() -> CollisionShape2D: |
| 方法 | get_generated_collision_shapes |
func get_generated_collision_shapes() -> Array[CollisionShape2D]: |
| 方法 | clear_generated_collision_shape |
func clear_generated_collision_shape() -> void: |
| 方法 | clear_generated_collision_shapes |
func clear_generated_collision_shapes() -> void: |
| 方法 | can_receive_hit |
func can_receive_hit(p_hit_id: StringName = &"") -> bool: |
| 方法 | receive_hit |
func receive_hit(context: GFCombatHitContext) -> Dictionary: |
信号¶
hit_validating¶
- API：
public
命中进入自定义校验阶段时发出。
参数：
| 名称 | 说明 |
|---|---|
context |
命中上下文。 |
report |
当前结果报告副本。 |
结构：
report: Dictionary，当前命中接收报告，包含 ok、hit_id、receiver、reason、message 和 metadata。
hit_received¶
- API：
public
命中被接受时发出。
参数：
| 名称 | 说明 |
|---|---|
context |
命中上下文。 |
report |
结果报告。 |
结构：
report: Dictionary，统一命中接收报告，包含 ok、hit_id、receiver、reason、message 和 metadata。
hit_rejected¶
- API：
public
命中被拒绝时发出。
参数：
| 名称 | 说明 |
|---|---|
context |
命中上下文。 |
report |
结果报告。 |
结构：
report: Dictionary，统一命中接收报告，包含 ok、hit_id、receiver、reason、message 和 metadata。
enabled_changed¶
- API：
public
启用状态变化时发出。
参数：
| 名称 | 说明 |
|---|---|
enabled |
当前是否允许接收命中。 |
属性¶
enabled¶
- API：
public
是否允许接收命中。
accepted_hit_ids¶
- API：
public
非空时，只接受这些命中 ID。
rejected_hit_ids¶
- API：
public
始终拒绝的命中 ID。
metadata¶
- API：
public
接收器自定义元数据。框架不解释该字段。
结构：
metadata: Dictionary，接收器自定义命中元数据；会进入命中接收报告。
receiver_path¶
- API：
public
可选业务接收节点路径；为空时由当前 HurtBox 直接接收。
collision_shape_config¶
- API：
public
可选碰撞形状配置。设置后可自动生成或更新 CollisionShape2D 子节点。
collision_shape_configs¶
- API：
public
可选碰撞形状配置列表。非空时可自动生成或更新多个 CollisionShape2D 子节点。
auto_apply_collision_shape_config¶
- API：
public
是否在进入场景树或配置变化时自动应用碰撞形状配置。
validation_callback¶
- API：
public
自定义校验回调，建议签名为 func(context: GFCombatHitContext, report: Dictionary) -> Variant。 返回 bool 可直接决定是否接受；返回 Dictionary 可覆盖 ok、reason、metadata 等报告字段。
方法¶
apply_collision_shape_config¶
- API：
public
应用碰撞形状配置，创建或更新框架管理的 CollisionShape2D 子节点。
参数：
| 名称 | 说明 |
|---|---|
config |
可选配置；为空时使用 collision_shape_config。 |
返回：创建或更新的 CollisionShape2D；配置无效时返回 null。
apply_collision_shape_configs¶
- API：
public
func apply_collision_shape_configs(configs: Array[GFHitCollisionShapeConfig2D] = []) -> Array[CollisionShape2D]:
应用碰撞形状配置列表，创建或更新框架管理的多个 CollisionShape2D 子节点。
参数：
| 名称 | 说明 |
|---|---|
configs |
可选配置列表；为空时使用 collision_shape_configs。 |
返回：创建或更新的 CollisionShape2D 列表。
get_generated_collision_shape¶
- API：
public
获取框架管理的 CollisionShape2D 子节点。
返回：存在则返回 CollisionShape2D，否则返回 null。
get_generated_collision_shapes¶
- API：
public
获取框架管理的 CollisionShape2D 子节点列表。
返回：已生成的 CollisionShape2D 列表。
clear_generated_collision_shape¶
- API：
public
移除框架管理的 CollisionShape2D 子节点。
clear_generated_collision_shapes¶
- API：
public
移除框架管理的全部 CollisionShape2D 子节点。
can_receive_hit¶
- API：
public
检查指定命中 ID 是否可被当前接收器接受。
参数：
| 名称 | 说明 |
|---|---|
p_hit_id |
命中 ID。 |
返回：可接受时返回 true。
receive_hit¶
- API：
public
接收一次命中。
参数：
| 名称 | 说明 |
|---|---|
context |
命中上下文。 |
返回：统一结果报告。
结构：
return: Dictionary，统一命中接收报告，包含 ok、hit_id、receiver、reason、message 和 metadata。