Referencia › Referencia de funciones › Platform

Platform.roster_class.GetRosterClassObservation

pública

Llamar como

addon.Platform:GetRosterClassObservation(unit)

Disponible directamente a través de addon; no hace falta ninguna dependencia.

Qué hace

Lee la identidad pública de la lista del grupo en familias de cliente identificadas. La entrada se limita a player, de party1 a party4 y de raid1 a raid40. Llama primero a UnitExists con ese token exacto de un argumento; un false conocido devuelve false sin consultar la clase. Para una unidad presente, solo consume el segundo retorno de UnitClass como cadena de nombre de archivo de clase legible y no vacía, sin restringirla a un enum de clases. Los datos necesarios que faltan, fallan, están mal formados o restringidos devuelven nil con un motivo.

Argumentos

NombreTipoQué hace
selfRMPlatformAdaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).
unitstringToken exacto propiedad de la función auxiliar: player, party1..party4 o raid1..raid40.

Retornos

1string | boolean | nilCadena del nombre de archivo de clase observado, false si se sabe que la unidad está ausente o nil si no está disponible.
2string | nilMotivo de validación, política 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 recurre a 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 juegoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitClassClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Valores secretos (Retail y Forever)

En Retail y Forever, el juego entrega a los addons valores secretos. Esta función auxiliar comprueba 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

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

Dependencias

Código fuente

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

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

Volver a Referencia de funciones