Referenz › Funktionsreferenz › Platform

Platform.unit_metadata.GetUnitMetadataObservation

öffentlich

Aufruf als

addon.Platform:GetUnitMetadataObservation(unit, kind)

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

Was sie bewirkt

Nach Prüfung von UnitExists genau ein verwendetes natives Metadatenfeld der Einheit beobachten: class nutzt Rückgabewert zwei von UnitClass, creature den lokalisierten Namen aus UnitCreatureType und classification UnitClassification. Eine lesbar abwesende Einheit ergibt false, ohne Metadaten abzufragen. Ungenutzte Tupelfelder beeinflussen die Verfügbarkeit nicht; ein erforderlicher fehlender, fehlgeschlagener, nil-, eingeschränkter oder fehlerhafter Wert ergibt nil mit einem Grund. Es wird keine Ableitung von Spielerklasse, GUID, Enum oder Übersetzung hinzugefügt.

Argumente

NameTypWas sie bewirkt
selfRMPlatformPlattformadapter von Rotation Master (bei Doppelpunktaufrufen implizit).
unitstringExakte Einheitenkennung, die auf Existenz geprüft und an die gewählte Metadaten-API übergeben wird.
kindstringEines von class, creature oder classification; andere Metadatenarten werden nicht unterstützt.

Rückgabewerte

1string | boolean | nilLesbare verwendete Metadaten-Zeichenkette, false für eine bekannt abwesende Einheit oder nil, wenn erforderliche Daten nicht verfügbar sind.
2string | nilGrund aus Richtlinie, Abfragevalidierung oder Verfügbarkeit für eine nil-Metadatenbeobachtung.

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-APIClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitClassClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitClassificationClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitCreatureTypeClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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 classification = addon.Platform:GetUnitMetadataObservation("target", "classification")
if classification == nil then return nil end
return classification == "worldboss" or classification == "elite"

Quelle

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

Platform.unit_metadata.GetUnitMetadataObservation(self, unit, kind)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if kind~='class' and kind~='creature' and kind~='classification' then return nil,'invalid-unit-metadata-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local existsOk,exists=pcall(UnitExists,unit)
    if not existsOk then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    if not exists then return false end
    local api
    if kind=='class' then api=UnitClass
    elseif kind=='creature' then api=UnitCreatureType
    else api=UnitClassification end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,observed
    if kind=='class' then ok,observed=pcall(function() return select(2,api(unit)) end)
    else ok,observed=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(observed) then return nil,'restricted-value' end
    if observed==nil then return nil,'unit-metadata-unavailable' end
    if type(observed)~='string' or observed=='' then return nil,'invalid-api-result' end
    return observed

Zurück zu Funktionsreferenz