Справочник › Справочник функций › Platform

Platform.player_flags.GetPlayerFlagObservation

общедоступный

Как вызывать

addon.Platform:GetPlayerFlagObservation(kind)

Доступен напрямую через addon; зависимость не нужна.

Что делает

Наблюдать один независимый флаг игрока без аргументов: stealthed — IsStealthed, control — HasFullControl, outdoors — IsOutdoors. Читаемые true и false сохраняют свой смысл. Отсутствующие, неудачные, nil, ограниченные или повреждённые обязательные данные возвращают nil с причиной. Выводы о существовании, подземелье или применимости способностей не добавляются.

Аргументы

ИмяТипЧто делает
selfRMPlatformАдаптер платформы Rotation Master (неявно при вызове через двоеточие).
kindstringОдно из stealthed, control или outdoors; другие предикаты не вызываются.

Возвращает

1boolean | nilЧитаемый выбранный флаг или nil, если обязательные данные недоступны.
2string | nilПричина по политике, проверке запроса или недоступности для флага игрока nil.

Издания

Встроенные помощники регистрируются во всех изданиях. Различается игровой API, который они читают; если нужного API нет, помощник использует запасной вариант или возвращает nil с причиной.

  • Недоступно в этом издании (причина — во всплывающей подсказке)
  • Только пока включены запасные реализации Blizzard для устаревших функций
Игровой APIClassic EraTBC AnniversaryClassic ProgressionForeverRetail
HasFullControlClassic EraTBC AnniversaryClassic ProgressionForeverRetail
IsOutdoorsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
IsStealthedClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Секретные значения (Retail и Forever)

В Retail и Forever игра передаёт аддонам секретные значения. Этот помощник проверяет то, что читает (addon.Platform:CanReadValue), и вместо секретного значения, которое нельзя сравнить, возвращает nil с причиной, например restricted-value. Считайте nil недоступным значением, а не ложью.

Пример

local stealthed = addon.Platform:GetPlayerFlagObservation("stealthed")
local outdoors = addon.Platform:GetPlayerFlagObservation("outdoors")
if stealthed == nil or outdoors == nil then return nil end
return outdoors and not stealthed

Исходный код

Platform/player_flags.lua, строка 18. В игре только для чтения; «Дублировать» создаёт редактируемую копию.

Platform.player_flags.GetPlayerFlagObservation(self, kind)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(kind) then return nil,'restricted-value' end
    if kind~='stealthed' and kind~='control' and kind~='outdoors' then return nil,'invalid-player-flag-query' end
    local api
    if kind=='stealthed' then api=IsStealthed
    elseif kind=='control' then api=HasFullControl
    else api=IsOutdoors end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result=pcall(api)
    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,'player-flag-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

Назад: Справочник функций