參考資料 › 函式參考 › Platform

Platform.unit_presence.GetUnitPresenceObservation

公用

呼叫方式

addon.Platform:GetUnitPresenceObservation(unit)

可直接透過 addon 使用,不需要相依項目。

作用

在已識別的用戶端系列上觀測單位的存在性。將所選單位原樣傳給一次受保護的 UnitExists 呼叫。保留可讀的 true 與 false;所需觀測缺少、失敗、受限、為 nil 或格式錯誤時傳回 nil 及原因。不會新增身分、可見性、距離或戰鬥狀態的查詢。

參數

名稱類型作用
selfRMPlatformRotation Master 平台轉接器(使用冒號呼叫時隱含傳入)。
unitstring可讀的非空單位代碼,作為單一原生參數原樣傳遞。

傳回值

1boolean | nil已知的單位存在或不存在;所需觀測無法使用時為 nil。
2string | nil結果為 nil 時的用戶端系列、查詢驗證或所需觀測的可用性原因。

版本

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

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

機密值(正式版與永久)

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

範例

local present = addon.Platform:GetUnitPresenceObservation("focus")
if present == nil then return nil end
return not present

原始碼

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

Platform.unit_presence.GetUnitPresenceObservation(self, unit)
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    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

返回函式參考