參考資料 › 函式參考 › Platform

Platform.mobinfo2.presence

相依項目

呼叫方式

Platform.mobinfo2.presence(self, unit)

記錄相依項目 Platform.mobinfo2.presence,然後以該名稱呼叫。含命名空間的呼叫不會傳入 self:請使用冒號呼叫,或自行傳入該物件。

作用

Checks whether a unit exists with one protected UnitExists call. Returns true or false when readable; otherwise nil with "missing-api", "api-error", "restricted-value", "unit-data-unavailable" (nil result) or "invalid-api-result". GetMobInfo2Observation shares this result through the evaluation cache.

參數

名稱類型作用
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
unitstringUnit token passed unchanged to UnitExists; not validated here.

傳回值

1boolean | nilTrue when the unit exists, false when it does not; nil when unavailable.
2string | nilReason when the result is nil.

版本

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

  • 該版本無法使用(原因請見提示)
  • 僅在暴雪的棄用相容層開啟時
遊戲 API經典時代TBC 週年版經典進程永久正式版
UnitExists經典時代TBC 週年版經典進程永久正式版

機密值(正式版與永久)

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

範例

-- needs the dependency Platform.mobinfo2.presence
local exists = Platform.mobinfo2.presence(addon.Platform, "target")
if exists == nil then return nil end
return exists

原始碼

Platform/mobinfo2.lua,第 46 行。在遊戲中為唯讀;「複製」會產生一份可編輯的複本。

Platform.mobinfo2.presence(self, unit)
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    return exists

返回函式參考