Platform.pet.GetPetObservation

Aufruf als

addon.Platform:GetPetObservation(includeName)

Direkt über addon verfügbar; keine Abhängigkeit nötig.

Was sie bewirkt

Die exakte Existenz des Begleiters und optional seinen formatierten Anzeigenamen per GetUnitName beobachten. Reine Anwesenheitsabfragen benötigen nie Namensdaten. Bekannte Abwesenheit überspringt die Namensabfrage. Vorhandene Begleiter benötigen nur auf Anfrage einen lesbaren nichtleeren Namen; erforderliche fehlende, fehlgeschlagene, nil-, eingeschränkte oder fehlerhafte Beobachtungen ergeben nil mit einem Grund. Die Anzeigehilfsfunktion wird mit ihrem einzigen ursprünglichen Argument pet aufgerufen, ohne Rückgriff auf UnitName und ohne abgeleiteten Leisten-, Gesundheits- oder Fähigkeitszustand.

Argumente

Name	Typ	Was sie bewirkt
`self`	`RMPlatform`	Plattformadapter von Rotation Master (bei Doppelpunktaufrufen implizit).
`includeName`	`boolean \| nil`	True fragt den formatierten Begleiternamen ab; false oder ohne Angabe wird nur die Anwesenheit gelesen.

Rückgabewerte

1	`table \| nil`	Begleiterbeobachtung mit booleschem exists und, bei einem angefragten vorhandenen Begleiter, name; nil, wenn erforderliche Daten nicht verfügbar sind.
2	`string \| nil`	Grund aus Richtlinie, Abfragevalidierung oder Verfügbarkeit für eine nil-Begleiterbeobachtung.

Editionen

Integrierte Hilfsfunktionen werden auf jeder Edition registriert. Unterschiedlich ist die Spiel-API, die sie lesen; fehlt eine, weicht die Hilfsfunktion aus oder gibt nil mit einem Grund zurück.

Auf dieser Edition nicht verfügbar (den Grund nennt der Tooltip)
Nur, solange Blizzards Ersatz für veraltete Funktionen aktiv ist

Spiel-API
`GetUnitName`
`UnitExists`
`canaccessvalue`

Geheime Werte (Retail und Forever)

Auf Retail und Forever übergibt das Spiel Addons geheime Werte. Diese Hilfsfunktion prüft, was sie liest (addon.Platform:CanReadValue), und gibt statt eines geheimen Werts, den sie nicht vergleichen kann, nil mit einem Grund wie restricted-value zurück. Behandeln Sie nil als nicht verfügbar, nicht als false.

Beispiel

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

Quelle

Platform/pet.lua, Zeile 19. Im Spiel schreibgeschützt; Duplizieren erstellt eine bearbeitbare Kopie.

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

Zurück zu Funktionsreferenz