參考資料 › 函式參考 › Platform

Platform.unit_stat.GetUnitStatObservation

公用

呼叫方式

addon.Platform:GetUnitStatObservation(unit, stat)

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

作用

只從原生的第二個傳回值觀測有效屬性。在探測或受限政策用戶端上,先查詢確切的 UnitExists(unit),然後對選擇器 1..5 查詢 UnitStat(unit,stat),或對選擇器 6 查詢 UnitArmor(unit)。已知不存在時傳回 exists=false;所需資訊缺少、失敗、受限或非有限時傳回 nil。保留有限的帶正負號、小數與零值;忽略所有未使用的元組欄位。1..6 的路由是 RM 的選擇器政策,而非原生值域的限制。

參數

名稱類型作用
selfRMPlatformRotation Master 平台轉接器(使用冒號呼叫時隱含傳入)。
unitstring所選的非空單位代碼,在原生呼叫中保持不變。
statnumber整數形式的 RM 屬性選擇器 1..5,或 6 表示有效護甲。

傳回值

1table | nil記錄為 exists=false,或 exists=true 並帶有有限的 value;無法使用時為 nil。
2string | nil查詢、政策或觀測的可用性原因。

版本

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

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

機密值(正式版與永久)

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

範例

local armor = addon.Platform:GetUnitStatObservation("player", 6)
if not armor or not armor.exists then return nil end
return armor.value >= 10000

相依項目

原始碼

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

Platform.unit_stat.GetUnitStatObservation(self, unit, stat)
    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(stat) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if not finite(stat) or stat%1~=0 or stat<1 or stat>6 then return nil,'invalid-stat-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local existsOk,exists=pcall(UnitExists,unit)
    if not existsOk 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 {exists=false} end
    local fn
    if stat==6 then fn=UnitArmor else fn=UnitStat end
    if type(fn)~='function' then return nil,'missing-api' end
    local ok,_,effective
    if stat==6 then ok,_,effective=pcall(fn,unit)
    else ok,_,effective=pcall(fn,unit,stat) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(effective) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(effective) then return nil,'restricted-value' end
    if effective==nil then return nil,'stat-data-unavailable' end
    if not finite(effective) then return nil,'invalid-api-result' end
    return {exists=true,value=effective}

返回函式參考