參考資料 › 函式參考 › Core

Core.health_forecast_conditions.nativeValue

相依項目

呼叫方式

Core.health_forecast_conditions.nativeValue(self, unit, kind, cache)

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

作用

Reads a unit's current or maximum health through the platform's health-forecast observer and the evaluation cache, rejecting restricted, missing, nonfinite or negative values.

參數

名稱類型作用
selfRMAddonRotation Master addon instance whose Platform is used.
unitstringUnit token to read.
kindstring"current" or "maximum".
cachetable | nilEvaluation-pass cache passed to getCached, or nil to read directly.

傳回值

1number | nilHealth value, or nil when unavailable.
2string | nilReason for nil: missing-api, restricted-value, the observer's reason, health-data-unavailable or invalid-health-forecast-number.

版本

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

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

機密值(正式版與永久)

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

插件如何呼叫它

相依項目

原始碼

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

Core.health_forecast_conditions.nativeValue(self, unit, kind, cache)
    local platform=self.Platform
    if type(platform.GetHealthForecastValueObservation)~='function' then return nil,'missing-api' end
    local value,why=addon.Functions.cache.getCached(cache,platform.GetHealthForecastValueObservation,platform,unit,kind)
    if not platform:CanReadValue(value) then return nil,'restricted-value' end
    if value==nil then return nil,why or 'health-data-unavailable' end
    local valid,reason=finite(platform,value)
    if not valid then return nil,reason end
    if value<0 then return nil,'invalid-health-forecast-number' end
    return value

返回函式參考