Platform.groups.GetGroupMembership

呼叫方式

addon.Platform:GetGroupMembership(raidOnly)

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

作用

在已識別的用戶端系列上讀取公開的隊伍成員身分。未知用戶端不受支援。raidOnly 為 true 時檢查 IsInRaid；為 false 或 nil 時使用原生預設的隊伍類別檢查 IsInGroup。可讀的 false 結果維持為 false。缺少、失敗、格式錯誤或受限的觀測會傳回 nil 及原因。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`raidOnly`	`boolean \| nil`	為 true 時請求團隊成員身分；為 false 或 nil 時請求任何隊伍成員身分。

傳回值

1	`boolean \| nil`	觀測到的成員身分；無法使用時為 nil。
2	`string \| nil`	結果為 nil 時的驗證或可用性原因。

版本

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

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

遊戲 API
`IsInGroup`
`IsInRaid`

機密值（正式版與永久）

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

範例

local grouped = addon.Platform:GetGroupMembership(false)
local raid = addon.Platform:GetGroupMembership(true)
if grouped == nil or raid == nil then return nil end
return grouped and not raid -- in a party, not a raid

原始碼

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

Platform.groups.GetGroupMembership(self, raidOnly)

    if not self:CanReadValue(raidOnly) then return nil,'restricted-value' end
    if raidOnly~=nil and type(raidOnly)~='boolean' then return nil,'invalid-group-query' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    local fn
    if raidOnly then fn=IsInRaid else fn=IsInGroup end
    if type(fn)~='function' then return nil,'missing-api' end
    local ok,member=pcall(fn)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(member) then return nil,'restricted-value' end
    if member==nil then return nil,'group-data-unavailable' end
    if type(member)~='boolean' then return nil,'invalid-api-result' end
    return member

返回函式參考