Platform.unit_flags.GetUnitFlagObservation

Aufruf als

addon.Platform:GetUnitFlagObservation(unit, kind)

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

Was sie bewirkt

Ein aktuelles Einheiten-Flag beobachten: combat nutzt UnitAffectingCombat, enemy nutzt UnitIsEnemy mit player als erster Einheit und pvp nutzt UnitIsPVP. Eine lesbar abwesende Einheit ergibt false, ohne das Flag abzufragen. Erforderliche fehlende, fehlgeschlagene, eingeschränkte oder fehlerhafte Beobachtungen ergeben nil mit einem Grund. Die exakt ausgewählte Einheit bleibt erhalten; Freundlichkeit, Angreifbarkeit oder andere Einheitenzustände werden nicht abgeleitet.

Argumente

Name	Typ	Was sie bewirkt
`self`	`RMPlatform`	Plattformadapter von Rotation Master (bei Doppelpunktaufrufen implizit).
`unit`	`string`	Exakte Einheitenkennung, deren ausgewähltes Flag beobachtet werden soll.
`kind`	`string`	Eines von combat, enemy oder pvp; andere Flag-Arten werden nicht unterstützt.

Rückgabewerte

1	`boolean \| nil`	Lesbares ausgewähltes Flag, false für eine bekannt abwesende Einheit oder nil, wenn eine erforderliche Beobachtung nicht verfügbar ist.
2	`string \| nil`	Grund aus Richtlinie, Abfragevalidierung oder Verfügbarkeit für ein nil-Einheiten-Flag.

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
`UnitAffectingCombat`
`UnitExists`
`UnitIsEnemy`
`UnitIsPVP`

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 inCombat = addon.Platform:GetUnitFlagObservation("target", "combat")
local enemy = addon.Platform:GetUnitFlagObservation("target", "enemy")
if inCombat == nil or enemy == nil then return nil end
return enemy and not inCombat

Abhängigkeiten

readClientPolicy (builtin:Platform/unit_flags.lua:readClientPolicy)

Quelle

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

Platform.unit_flags.GetUnitFlagObservation(self, unit, kind)

    local policy=readClientPolicy(self)
    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~='combat' and kind~='enemy' and kind~='pvp' then return nil,'invalid-unit-flag-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=='combat' then api=UnitAffectingCombat
    elseif kind=='enemy' then api=UnitIsEnemy
    else api=UnitIsPVP end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='enemy' then ok,result=pcall(api,'player',unit)
    else ok,result=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'unit-flag-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

Zurück zu Funktionsreferenz