Platform.groups.GetUnitGroupMembership

呼叫方式

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

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

作用

讀取指定單位是否屬於玩家的隊伍或團隊。raidOnly 為 true 時只查詢 UnitInRaid；否則 UnitInParty 結果為 true 時直接傳回，為 false 時繼續查詢 UnitInRaid，未知時維持為無法使用。可讀的 nil 團隊索引表示 false；整數團隊索引 1..40 表示 true。名稱會原樣傳給原生 API；原生 API 是否接受名稱查詢需視用戶端而定。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`unit`	`string`	可讀的非空單位代碼或原生可辨識的名稱，原樣傳遞。
`raidOnly`	`boolean \| nil`	為 true 時只檢查團隊成員身分；為 false 或 nil 時先檢查隊伍再檢查團隊。

傳回值

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

版本

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

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

遊戲 API
`UnitInParty`
`UnitInRaid`
`canaccessvalue`

機密值（正式版與永久）

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

範例

local member = addon.Platform:GetUnitGroupMembership("focus", false)
if member == nil then return nil end
return member

原始碼

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

Platform.groups.GetUnitGroupMembership(self, unit, raidOnly)

    if not self:CanReadValue(unit) or not self:CanReadValue(raidOnly) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' or #unit>512 or unit:find('[%z\1-\31\127]') then return nil,'invalid-unit' 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
    if not raidOnly then
        if type(UnitInParty)~='function' then return nil,'missing-api' end
        local ok,member=pcall(UnitInParty,unit)
        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
        if member then return true end
    end
    if type(UnitInRaid)~='function' then return nil,'missing-api' end
    local ok,index=pcall(UnitInRaid,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(index) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(index) then return nil,'restricted-value' end
    -- The pinned native API returns an optional raid index: nil is nonmember.
    if index==nil then return false end
    if type(index)~='number' or index<1 or index>40 or index%1~=0 then return nil,'invalid-api-result' end
    return true

返回函式參考