Platform.unit_metadata.GetUnitMetadataObservation

呼叫方式

addon.Platform:GetUnitMetadataObservation(unit, kind)

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

作用

在檢查 UnitExists 後觀測一個所使用的原生單位中繼資料欄位：class 使用 UnitClass 的第二個傳回值，creature 使用在地化的 UnitCreatureType 名稱，classification 使用 UnitClassification。可讀且不存在的單位傳回 false，不查詢中繼資料。未使用的元組欄位不影響可用性；所需的值缺少、失敗、為 nil、受限或格式錯誤時傳回 nil 及原因。不會新增玩家職業、GUID、列舉或翻譯推斷。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`unit`	`string`	用於檢查存在性並傳給所選中繼資料 API 的確切單位代碼。
`kind`	`string`	class、creature 或 classification 之一；不支援其他中繼資料種類。

傳回值

1	`string \| boolean \| nil`	可讀的所使用中繼資料字串；已知單位不存在時為 false，所需資料無法使用時為 nil。
2	`string \| nil`	中繼資料觀測為 nil 時的政策、查詢驗證或可用性原因。

版本

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

該版本無法使用（原因請見提示）
僅在暴雪的棄用相容層開啟時

遊戲 API
`UnitClass`
`UnitClassification`
`UnitCreatureType`
`UnitExists`

機密值（正式版與永久）

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

範例

local classification = addon.Platform:GetUnitMetadataObservation("target", "classification")
if classification == nil then return nil end
return classification == "worldboss" or classification == "elite"

原始碼

Platform/unit_metadata.lua，第 21 行。在遊戲中為唯讀；「複製」會產生一份可編輯的複本。

Platform.unit_metadata.GetUnitMetadataObservation(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
    if kind~='class' and kind~='creature' and kind~='classification' then return nil,'invalid-unit-metadata-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 false end
    local api
    if kind=='class' then api=UnitClass
    elseif kind=='creature' then api=UnitCreatureType
    else api=UnitClassification end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,observed
    if kind=='class' then ok,observed=pcall(function() return select(2,api(unit)) end)
    else ok,observed=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(observed) then return nil,'restricted-value' end
    if observed==nil then return nil,'unit-metadata-unavailable' end
    if type(observed)~='string' or observed=='' then return nil,'invalid-api-result' end
    return observed

返回函式參考