参考 › 函数参考 › Conditions

Conditions.spatial.combatFilter

依赖项

调用方式

Conditions.spatial.combatFilter(value, cache, unit)

记录依赖项 Conditions.spatial.combatFilter,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。

作用

Applies the In Combat option of Distance Count to one unit: with the option off every unit passes, with it on the unit must be in combat (UnitAffectingCombat).

参数

名称类型作用
valuetableThe Distance Count condition value; its incombat field turns the filter on.
cachetableThe evaluation cache the reads go through.
unitstringToken of the unit being counted.

返回值

1boolean | nilTrue when the unit passes; nil when its combat state cannot be read.
2string | nilReason code when the first result is nil.

版本

内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API;某个 API 缺失时,辅助函数会改用后备方案,或返回 nil 并附上原因。

  • 该版本不可用(原因见提示)
  • 仅在暴雪的弃用兼容层开启时
游戏 API经典旧世TBC 周年版经典进阶服永久服正式服
UnitAffectingCombat经典旧世TBC 周年版经典进阶服永久服正式服

插件如何调用它

依赖项

源码

Conditions/spatial.lua,第 673 行。在游戏中为只读;“复制”会生成一份可编辑的副本。

Conditions.spatial.combatFilter(value, cache, unit)
    if not value.incombat then return true end
    local fighting,why=booleanRead(cache,UnitAffectingCombat,unit)
    if fighting==nil then return nil,why end
    return fighting

返回函数参考