Platform.pet.GetPetObservation

Llamar como

addon.Platform:GetPetObservation(includeName)

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

Qué hace

Observa la existencia exacta de la mascota y, opcionalmente, su nombre visible formateado de GetUnitName. Las consultas solo de presencia nunca requieren datos de nombre. Una ausencia conocida omite la consulta del nombre. Las mascotas presentes requieren un nombre legible no vacío solo cuando se solicita; las observaciones necesarias que faltan, fallan, son nil, están restringidas o mal formadas devuelven nil con un motivo. La función auxiliar de visualización se llama con su único argumento original de mascota, sin alternativa con UnitName ni estado deducido de barra, salud o habilidades.

Argumentos

Nombre	Tipo	Qué hace
`self`	`RMPlatform`	Adaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).
`includeName`	`boolean \| nil`	True solicita el nombre de mascota formateado; false o la omisión solo leen la presencia.

Retornos

1	`table \| nil`	Observación de la mascota con exists booleano y, para una mascota presente solicitada, name; nil cuando faltan datos necesarios.
2	`string \| nil`	Motivo de política, validación de la consulta o disponibilidad para una observación de mascota 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 juego
`GetUnitName`
`UnitExists`
`canaccessvalue`

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

local pet = addon.Platform:GetPetObservation(false)
if not pet then return nil end
return not pet.exists -- time to summon

Código fuente

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

Platform.pet.GetPetObservation(self, includeName)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(includeName) then return nil,'restricted-value' end
    if includeName~=nil and type(includeName)~='boolean' then return nil,'invalid-pet-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,'pet')
    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,'pet-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local record={exists=exists}
    if not exists or not includeName then return record end
    if type(GetUnitName)~='function' then return nil,'missing-api' end
    local nameOk,name=pcall(GetUnitName,'pet')
    if not nameOk then return nil,'api-error' end
    if not self:CanReadValue(name) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(name) then return nil,'restricted-value' end
    if name==nil then return nil,'pet-name-unavailable' end
    if type(name)~='string' or name=='' then return nil,'invalid-api-result' end
    record.name=name
    return record

Volver a Referencia de funciones