參考資料 › 函式參考 › Platform

Platform.health_forecast.GetHealthForecastValueObservation

公用

呼叫方式

addon.Platform:GetHealthForecastValueObservation(unit, kind)

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

作用

在另外的身分檢查之後讀取惰性的生命力純量。current 種類使用確切的 UnitHealth(unit);maximum 使用確切的 UnitHealthMax(unit)。探測或受限政策用戶端接受可讀的有限非負數字(包括零)。不會重複呼叫存在性/GUID 查詢,也不會改用其他元組。

參數

名稱類型作用
selfRMPlatformRotation Master 平台轉接器(使用冒號呼叫時隱含傳入)。
unitstring所選的非空單位代碼;僅憑此呼叫不能確定其存在。
kindstring封閉的純量種類:current 或 maximum。

傳回值

1number | nil有限的非負原生生命力純量;無法使用時為 nil。
2string | nil政策、驗證或所需觀測的可用性原因。

版本

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

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

機密值(正式版與永久)

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

範例

local current = addon.Platform:GetHealthForecastValueObservation("target", "current")
local maximum = addon.Platform:GetHealthForecastValueObservation("target", "maximum")
if not current or not maximum or maximum == 0 then return nil end
return current / maximum <= 0.35

相依項目

原始碼

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

Platform.health_forecast.GetHealthForecastValueObservation(self, unit, kind)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    local api
    if kind=='current' then api=UnitHealth
    elseif kind=='maximum' then api=UnitHealthMax
    else return nil,'invalid-health-forecast-query' end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,value=pcall(api,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(value) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(value) then return nil,'restricted-value' end
    if value==nil then return nil,'health-data-unavailable' end
    if not finite(value) or value<0 then return nil,'invalid-api-result' end
    return value

返回函式參考