參考資料 › 函式參考 › Platform

Platform.health_forecast.GetHealthForecastIdentityObservation

公用

呼叫方式

addon.Platform:GetHealthForecastIdentityObservation(unit)

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

作用

在探測或受限政策用戶端上觀測確切的 UnitExists(unit),然後僅對存在的單位觀測 UnitGUID(unit)。已知不存在時為 false。存在的身分要求可讀的非空 GUID;所需資訊缺少、失敗、格式錯誤或受限時為無法使用。不會新增生命力、提供者或額外單位的觀測。

參數

名稱類型作用
selfRMPlatformRotation Master 平台轉接器(使用冒號呼叫時隱含傳入)。
unitstring所選的非空單位代碼。

傳回值

1string | boolean | nil存在時為 GUID;已知不存在時為 false,無法使用時為 nil。
2string | nil政策、驗證或觀測的可用性原因。

版本

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

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

機密值(正式版與永久)

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

範例

local guid = addon.Platform:GetHealthForecastIdentityObservation("target")
-- false when there is no target, nil when unavailable
if not guid then return guid end
return guid:sub(1, 9) == "Creature-"

原始碼

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

Platform.health_forecast.GetHealthForecastIdentityObservation(self, unit)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' 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
    if not exists then return false end
    if type(UnitGUID)~='function' then return nil,'missing-api' end
    local success,guid=pcall(UnitGUID,unit)
    if not success then return nil,'api-error' end
    if not self:CanReadValue(guid) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(guid) then return nil,'restricted-value' end
    if guid==nil then return nil,'unit-guid-unavailable' end
    if type(guid)~='string' or guid=='' then return nil,'invalid-api-result' end
    return guid

返回函式參考