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.

參數

名稱	類型	作用
`cache`	`table \| nil`	Evaluation-pass cache passed to getCached, or nil to read directly.
`method`	`function`	Game API to call, such as UnitExists or UnitIsEnemy.
`...`	`any`	Arguments forwarded to method.

傳回值

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

版本

內建輔助函式在每個版本上都會註冊。不同的是它們讀取的遊戲 API；某個 API 不存在時，輔助函式會改用備用方式，或傳回 nil 並附上原因。

它不會直接讀取任何遊戲 API。

機密值（正式版與永久）

在正式版與永久上，遊戲交給插件的是機密值。此輔助函式會檢查它讀取的內容（addon.Platform:CanReadValue），遇到無法比較的機密值時，會傳回 nil 並附上原因（例如 restricted-value），而不是傳回該機密值。請將 nil 視為無法使用，而非假。

插件如何呼叫它

距離內計數 (evaluate)

local present,issue=booleanRead(cache,UnitExists,entity.unit)

Conditions.spatial.combatFilter

local fighting,why=booleanRead(cache,UnitAffectingCombat,unit)

Conditions.spatial.nameplateDistanceCount

local present,issue=booleanRead(cache,UnitExists,unit)

相依項目

protectedRead → Conditions.spatial.protectedRead

原始碼

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"

返回函式參考