Platform.roster_class.GetRosterClassObservation

呼叫方式

addon.Platform:GetRosterClassObservation(unit)

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

作用

在已識別的用戶端系列上讀取公開的名單身分。輸入路由僅限 player、party1 到 party4，以及 raid1 到 raid40。先以該確切的單參數代碼呼叫 UnitExists；已知為 false 時直接傳回 false，不查詢職業。對於存在的單位，只使用 UnitClass 的第二個傳回值作為可讀的非空職業檔名字串，不限制職業列舉。所需資訊缺少、失敗、格式錯誤或受限時傳回 nil 及原因。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`unit`	`string`	由輔助函式擁有的確切代碼：player、party1..party4 或 raid1..raid40。

傳回值

1	`string \| boolean \| nil`	觀測到的職業檔名字串；已知單位不存在時為 false，無法使用時為 nil。
2	`string \| nil`	結果為 nil 時的驗證、政策或可用性原因。

版本

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

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

遊戲 API
`UnitClass`
`UnitExists`
`canaccessvalue`

機密值（正式版與永久）

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

範例

for index = 1, 4 do
  local class = addon.Platform:GetRosterClassObservation("party" .. index)
  if class == "PRIEST" then return true end
end
return false

相依項目

rosterUnit → Platform.roster_class.rosterUnit

原始碼

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

Platform.roster_class.GetRosterClassObservation(self, unit)

    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or not rosterUnit(unit) then return nil,'invalid-roster-unit' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,unit)
    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,'roster-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    if not exists then return false end
    if type(UnitClass)~='function' then return nil,'missing-api' end
    local success,_,class=pcall(UnitClass,unit)
    if not success then return nil,'api-error' end
    if not self:CanReadValue(class) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(class) then return nil,'restricted-value' end
    if class==nil then return nil,'roster-class-unavailable' end
    if type(class)~='string' or class=='' then return nil,'invalid-api-result' end
    return class

返回函式參考