Platform.pet.GetPetObservation

呼叫方式

addon.Platform:GetPetObservation(includeName)

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

作用

觀測寵物是否確切存在，並可選擇性地觀測其經 GetUnitName 格式化的顯示名稱。僅查詢存在性時從不需要名稱資料。已知不存在時會略過名稱查詢。僅在請求時，存在的寵物才需要可讀的非空名稱；所需觀測缺少、失敗、為 nil、受限或格式錯誤時傳回 nil 及原因。顯示輔助函式只以原有的單一寵物參數呼叫，不改用 UnitName，也不推斷快捷列、生命力或技能狀態。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`includeName`	`boolean \| nil`	為 true 時請求格式化的寵物名稱；為 false 或省略時只讀取存在性。

傳回值

1	`table \| nil`	寵物觀測，包含布林值 exists，對於請求的存在的寵物還包含 name；所需資料無法使用時為 nil。
2	`string \| nil`	寵物觀測為 nil 時的政策、查詢驗證或可用性原因。

版本

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

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

遊戲 API
`GetUnitName`
`UnitExists`
`canaccessvalue`

機密值（正式版與永久）

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

範例

local pet = addon.Platform:GetPetObservation(false)
if not pet then return nil end
return not pet.exists -- time to summon

原始碼

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

Platform.pet.GetPetObservation(self, includeName)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(includeName) then return nil,'restricted-value' end
    if includeName~=nil and type(includeName)~='boolean' then return nil,'invalid-pet-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,'pet')
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'pet-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local record={exists=exists}
    if not exists or not includeName then return record end
    if type(GetUnitName)~='function' then return nil,'missing-api' end
    local nameOk,name=pcall(GetUnitName,'pet')
    if not nameOk then return nil,'api-error' end
    if not self:CanReadValue(name) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(name) then return nil,'restricted-value' end
    if name==nil then return nil,'pet-name-unavailable' end
    if type(name)~='string' or name=='' then return nil,'invalid-api-result' end
    record.name=name
    return record

返回函式參考