Platform.form.GetPlayerFormObservation

呼叫方式

addon.Platform:GetPlayerFormObservation()

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

作用

使用一次受保護的無參數 GetShapeshiftForm 呼叫觀測玩家目前的形態。保留每個可讀的有限數字結果，包括零、帶正負號與小數值；不會推斷更嚴格的原生索引範圍。缺少、失敗、為 nil、受限或非有限的資料維持為無法使用。不會新增形態數量、職業、法術 ID、單位或選擇性參數。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。

傳回值

1	`number \| nil`	可讀的有限目前形態觀測，包括與目前未變形狀態比較時的零；無法使用時為 nil。
2	`string \| nil`	形態為 nil 時的用戶端政策、功能、呼叫或觀測可用性原因。

版本

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

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

遊戲 API
`GetShapeshiftForm`
`canaccessvalue`

機密值（正式版與永久）

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

範例

local form = addon.Platform:GetPlayerFormObservation()
if form == nil then return nil end
return form == 0 -- not shapeshifted

原始碼

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

Platform.form.GetPlayerFormObservation(self)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if type(GetShapeshiftForm)~='function' then return nil,'missing-api' end
    local ok,result=pcall(GetShapeshiftForm)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'form-unavailable' end
    if type(result)~='number' or result~=result or result==math.huge or result==-math.huge then return nil,'invalid-api-result' end
    return result

返回函式參考