GFEquipmentSlot¶
API Reference / Domain / 类索引
- 路径:
addons/gf/extensions/domain/equipment/gf_equipment_slot.gd - 模块:
Domain - 继承:
Resource - API:
public - 类别:资源定义 (
resource_definition) - 首次版本:
3.17.0
通用装备/挂载槽位。 槽位只记录可接受标签和已挂载 item_id,不规定装备类型。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | slot_id |
var slot_id: StringName = &"" |
| 属性 | item_id |
var item_id: StringName = &"" |
| 属性 | accepted_tags |
var accepted_tags: Array[StringName] = [] |
| 属性 | require_all_tags |
var require_all_tags: bool = false |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | can_accept |
func can_accept(item_tags: Array[StringName]) -> bool: |
| 方法 | equip |
func equip(p_item_id: StringName, item_tags: Array[StringName] = []) -> bool: |
| 方法 | unequip |
func unequip() -> void: |
属性¶
slot_id¶
- API:
public
槽位 ID。
item_id¶
- API:
public
当前挂载的物品 ID。
accepted_tags¶
- API:
public
接受的物品标签。为空表示不限制。
结构:
accepted_tags: Array[StringName],槽位接受的物品标签;为空时不限制。
require_all_tags¶
- API:
public
是否要求物品同时拥有全部 accepted_tags。false 表示拥有任一标签即可。
metadata¶
- API:
public
自定义元数据。
结构:
metadata: Dictionary,项目自定义槽位元数据;GF 不读取或改写其中字段。
方法¶
can_accept¶
- API:
public
检查标签是否可被槽位接受。
参数:
| 名称 | 说明 |
|---|---|
item_tags |
物品标签。 |
返回:可接受时返回 true。
结构:
item_tags: Array[StringName],当前物品拥有的标签列表。
equip¶
- API:
public
挂载物品。
参数:
| 名称 | 说明 |
|---|---|
p_item_id |
物品 ID。 |
item_tags |
物品标签。 |
返回:成功时返回 true。
结构:
item_tags: Array[StringName],当前物品拥有的标签列表。
unequip¶
- API:
public
清空槽位。