调用方式
Conditions.equipment.matches(value, record)
记录依赖项 Conditions.equipment.matches,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。
作用
Tests one equipment slot record against a WEAPON_TYPE condition: empty slot, shield, any weapon, holdable, one-hand, two-hand, ranged, or a specific weapon subclass. Returns nil with a reason when the item's class or equip location is not known yet.
参数
| 名称 | 类型 | 作用 |
|---|---|---|
value | table | Condition settings: kind (empty, shield, weapon, holdable, onehand, twohand or ranged) or a weapon subclass ID in subclass. |
record | table | boolean | Slot record with classID, subClassID, equipLoc and an optional typeReason, or false for an empty slot. |
返回值
| 1 | boolean | nil | Whether the slot matches, or nil when it cannot be decided. |
|---|---|---|
| 2 | string | nil | Reason for nil: the record's typeReason, item-data-unavailable or invalid-weapon-type. |
版本
内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API;某个 API 缺失时,辅助函数会改用后备方案,或返回 nil 并附上原因。
它不直接读取任何游戏 API。
插件如何调用它
- 武器类型 (evaluate)
return matches(value, record)
依赖项
ARMOR_CLASS(builtin:Conditions/equipment.lua:ARMOR_CLASS)ONEHAND(builtin:Conditions/equipment.lua:ONEHAND)RANGED(builtin:Conditions/equipment.lua:RANGED)SHIELD_SUBCLASS(builtin:Conditions/equipment.lua:SHIELD_SUBCLASS)WEAPON_CLASS(builtin:Conditions/equipment.lua:WEAPON_CLASS)
源码
Conditions/equipment.lua,第 119 行。在游戏中为只读;“复制”会生成一份可编辑的副本。
Conditions.equipment.matches(value, record)
if record == false then return value.kind == "empty" end
if value.kind == "empty" then return false end
if record.classID == nil then return nil, record.typeReason or "item-data-unavailable" end
if value.subclass ~= nil then
return record.classID == WEAPON_CLASS and record.subClassID == value.subclass
end
local kind = value.kind
if kind == "shield" then return record.classID == ARMOR_CLASS and record.subClassID == SHIELD_SUBCLASS end
if kind == "weapon" then return record.classID == WEAPON_CLASS end
if record.equipLoc == nil then return nil, "item-data-unavailable" end
if kind == "holdable" then return record.equipLoc == "INVTYPE_HOLDABLE" end
if record.classID ~= WEAPON_CLASS then return false end
if kind == "onehand" then return ONEHAND[record.equipLoc] == true end
if kind == "twohand" then return record.equipLoc == "INVTYPE_2HWEAPON" end
if kind == "ranged" then return RANGED[record.equipLoc] == true end
return nil, "invalid-weapon-type"