Platform.unit_states.GetUnitStateObservation

呼叫方式

addon.Platform:GetUnitStateObservation(unit, kind)

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

作用

在探測或受限政策用戶端上，觀測確切的所選單位是否死亡或處於鬼魂狀態，或是否對玩家友好。所需觀測缺少、失敗、受限或格式錯誤時為無法使用。單位不存在時為無法使用，而不是否定比對，在 NOT 下同樣如此。不會保留跨輪詢的狀態。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`unit`	`string`	要觀測的確切非空單位代碼。
`kind`	`string`	只能是 dead（對應 UnitIsDeadOrGhost）或 friendly（對應 UnitIsFriend(player, unit)）。

傳回值

1	`boolean \| nil`	可讀的目前狀態；無法使用時為 nil。
2	`string \| nil`	無法讀取目前狀態時的可用性或查詢驗證原因。

版本

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

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

遊戲 API
`UnitExists`
`UnitIsDeadOrGhost`
`UnitIsFriend`

機密值（正式版與永久）

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

範例

local friendly = addon.Platform:GetUnitStateObservation("target", "friendly")
local dead = addon.Platform:GetUnitStateObservation("target", "dead")
if friendly == nil or dead == nil then return nil end
return friendly and dead -- a friend to resurrect

原始碼

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

Platform.unit_states.GetUnitStateObservation(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~='dead' and kind~='friendly' then return nil,'invalid-unit-state-query' end
    local existsAPI=UnitExists
    if type(existsAPI)~='function' then return nil,'missing-api' end
    local existsOK,exists=pcall(existsAPI,unit)
    if not existsOK then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil or exists==false then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local api
    if kind=='dead' then api=UnitIsDeadOrGhost else api=UnitIsFriend end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='friendly' then ok,result=pcall(api,'player',unit)
    else ok,result=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'unit-state-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

返回函式參考