參考資料 › 函式參考 › Platform

Platform.points.GetUnitPointIdentityObservation

公用

呼叫方式

addon.Platform:GetUnitPointIdentityObservation(unit, includeClass)

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

作用

為點數資源條件觀測確切的所選單位是否存在,並可選擇性地觀測其職業檔名。已知不存在時傳回 exists=false,不讀取職業。存在的單位只在請求時需要 UnitClass 的第二個傳回值;未使用的在地化名稱與 ID 不影響可用性。所需觀測缺少、失敗、受限或格式錯誤時維持為無法使用。這不會選擇資源或快取身分。

參數

名稱類型作用
selfRMPlatformRotation Master 平台轉接器(使用冒號呼叫時隱含傳入)。
unitstring原樣傳給 UnitExists 以及(必要時)UnitClass 的確切單位代碼。
includeClassboolean為 true 時還要求存在單位的職業檔名;為 false 時只讀取存在性。

傳回值

1table | nil可讀記錄,包含布林值 exists,存在時還包含所請求的職業檔名;所需資料無法使用時為 nil。
2string | nil記錄為 nil 時的政策、查詢驗證或所需觀測的可用性原因。

版本

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

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

機密值(正式版與永久)

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

範例

local record = addon.Platform:GetUnitPointIdentityObservation("target", true)
if not record then return nil end
return record.exists and record.class == "ROGUE"

原始碼

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

Platform.points.GetUnitPointIdentityObservation(self, unit, includeClass)
    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(includeClass) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if type(includeClass)~='boolean' then return nil,'invalid-point-identity-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 canaccessvalue and not canaccessvalue(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
    if not includeClass then return {exists=true} end
    if type(UnitClass)~='function' then return nil,'missing-api' end
    local ok,_,class=pcall(UnitClass,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(class) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(class) then return nil,'restricted-value' end
    if class==nil then return nil,'point-class-unavailable' end
    if type(class)~='string' or class=='' then return nil,'invalid-api-result' end
    return {exists=true,class=class}

返回函式參考