Platform.unit_flags.GetUnitFlagObservation

呼叫方式

addon.Platform:GetUnitFlagObservation(unit, kind)

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

作用

觀測一個目前的單位標記：combat 使用 UnitAffectingCombat，enemy 使用以 player 為第一個單位的 UnitIsEnemy，pvp 使用 UnitIsPVP。可讀且不存在的單位傳回 false，不查詢該標記。所需觀測缺少、失敗、受限或格式錯誤時傳回 nil 及原因。這會保留確切的所選單位，不推斷友好、可攻擊或其他單位狀態。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`unit`	`string`	要觀測其所選標記的確切單位代碼。
`kind`	`string`	combat、enemy 或 pvp 之一；不支援其他標記種類。

傳回值

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

版本

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

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

遊戲 API
`UnitAffectingCombat`
`UnitExists`
`UnitIsEnemy`
`UnitIsPVP`

機密值（正式版與永久）

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

範例

local inCombat = addon.Platform:GetUnitFlagObservation("target", "combat")
local enemy = addon.Platform:GetUnitFlagObservation("target", "enemy")
if inCombat == nil or enemy == nil then return nil end
return enemy and not inCombat

相依項目

readClientPolicy (builtin:Platform/unit_flags.lua:readClientPolicy)

原始碼

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

Platform.unit_flags.GetUnitFlagObservation(self, unit, kind)

    local policy=readClientPolicy(self)
    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~='combat' and kind~='enemy' and kind~='pvp' then return nil,'invalid-unit-flag-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=='combat' then api=UnitAffectingCombat
    elseif kind=='enemy' then api=UnitIsEnemy
    else api=UnitIsPVP end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='enemy' 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-flag-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

返回函式參考