Platform.pet.GetPetObservation

Appel

addon.Platform:GetPetObservation(includeName)

Disponible directement via addon ; aucune dépendance n'est nécessaire.

Ce qu'elle fait

Observe l'existence exacte du familier et, en option, son nom d'affichage mis en forme par GetUnitName. Les requêtes de présence seule n'exigent jamais de données de nom. Une absence connue évite la requête de nom. Les familiers présents n'exigent un nom lisible non vide que sur demande ; les observations requises manquantes, en échec, nil, restreintes ou mal formées renvoient nil avec un motif. La fonction d'affichage est appelée avec son unique argument pet d'origine, sans repli sur UnitName ni déduction de l'état de la barre, des points de vie ou des techniques.

Arguments

Nom	Type	Ce qu'elle fait
`self`	`RMPlatform`	Adaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
`includeName`	`boolean \| nil`	true demande le nom mis en forme du familier ; false ou omis ne lit que la présence.

Retours

1	`table \| nil`	Observation du familier avec exists booléen et, pour un familier présent demandé, name ; nil si des données requises sont indisponibles.
2	`string \| nil`	Motif de politique, de validation de la requête ou de disponibilité pour une observation de familier nil.

Éditions

Les fonctions utilitaires intégrées sont enregistrées sur toutes les éditions. Ce qui diffère, c'est l'API du jeu qu'elles lisent ; quand l'une manque, la fonction utilitaire se rabat sur une alternative ou renvoie nil avec une raison.

Indisponible sur cette édition (la raison figure dans l'infobulle)
Uniquement tant que les solutions de repli de Blizzard pour les fonctions obsolètes sont actives

API du jeu
`GetUnitName`
`UnitExists`
`canaccessvalue`

Valeurs secrètes (Retail et Forever)

Sur Retail et Forever, le jeu transmet aux addons des valeurs secrètes. Cette fonction utilitaire vérifie ce qu'elle lit (addon.Platform:CanReadValue) et renvoie nil avec une raison telle que restricted-value au lieu d'une valeur secrète qu'elle ne peut pas comparer. Traitez nil comme indisponible, pas comme false.

Exemple

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

Source

Platform/pet.lua, ligne 19. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

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

Retour à Référence des fonctions