参考 › 函数参考 › Conditions

Conditions.spatial.booleanRead

依赖项

调用方式

Conditions.spatial.booleanRead(cache, method, ...)

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

作用

Calls a yes/no game API through the evaluation cache, protected against errors, for the distance conditions. Accepts nil, false and 0 as no and true and 1 as yes; a missing API, an error, a restricted value or any other answer gives nil with a reason.

参数

名称类型作用
cachetable | nilEvaluation-pass cache passed to getCached, or nil to read directly.
methodfunctionGame API to call, such as UnitExists or UnitIsEnemy.
...anyArguments forwarded to method.

返回值

1boolean | nilThe answer, or nil when it cannot be read.
2string | nilReason for nil: missing-api, api-error, restricted-value or invalid-api-result.

版本

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

它不直接读取任何游戏 API。

秘密值(正式服和永久服)

在正式服和永久服上,游戏交给插件的是秘密值。此辅助函数会检查它读取的内容(addon.Platform:CanReadValue),遇到无法比较的秘密值时返回 nil 并附上原因(例如 restricted-value),而不是返回该秘密值。请将 nil 视为不可用,而不是假。

插件如何调用它

依赖项

源码

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

Conditions.spatial.booleanRead(cache, method, ...)
    local ok,result=protectedRead(cache,method,...)
    if not ok then return nil,result=="missing-api" and result or "api-error" end
    if not addon.Platform:CanReadValue(result) then return nil,"restricted-value" end
    if result==nil or result==false or result==0 then return false end
    if result==true or result==1 then return true end
    return nil,"invalid-api-result"

返回函数参考