Platform.groups.GetUnitGroupMembership

Llamar como

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

Disponible directamente a través de addon; no se necesita ninguna dependencia.

Qué hace

Lee la pertenencia de una unidad concreta al grupo o a la banda del jugador. Con raidOnly true solo consulta UnitInRaid; si no, un resultado true de UnitInParty corta la evaluación, false pasa a UnitInRaid y desconocido sigue sin estar disponible. Un índice de banda nil legible significa false; un índice de banda entero 1..40 significa true. Los nombres se pasan sin cambios a las API nativas; que la consulta nativa acepte nombres requiere la cualificación del cliente.

Argumentos

Nombre	Tipo	Qué hace
`self`	`RMPlatform`	Adaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).
`unit`	`string`	Token de unidad legible y no vacío o nombre reconocido de forma nativa, que se pasa sin cambios.
`raidOnly`	`boolean \| nil`	True solo comprueba la pertenencia a la banda; false o nil comprueban el grupo y luego la banda.

Retornos

1	`boolean \| nil`	Pertenencia observada, o nil si no está disponible.
2	`string \| nil`	Motivo de validación o disponibilidad para un resultado nil.

Ediciones

Las funciones auxiliares integradas se registran en todas las ediciones. Lo que cambia es la API del juego que leen; donde falta alguna, la función auxiliar usa una alternativa o devuelve nil con un motivo.

No disponible en esa edición (el motivo aparece en la información emergente)
Solo mientras estén activas las alternativas de Blizzard para API obsoletas

API del juego
`UnitInParty`
`UnitInRaid`
`canaccessvalue`

Valores secretos (Retail y Forever)

En Retail y Forever, el juego les entrega a los addons valores secretos. Esta función auxiliar verifica lo que lee (addon.Platform:CanReadValue) y, en lugar de un secreto que no puede comparar, devuelve nil con un motivo como restricted-value. Trata nil como no disponible, no como falso.

Ejemplo

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

Código fuente

Platform/groups.lua, línea 45. Solo lectura en el juego; Duplicar crea una copia editable.

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

Volver a Referencia de funciones