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

Platform.player_movement.GetPlayerMovementObservation

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

Как вызывать

addon.Platform:GetPlayerMovementObservation()

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

Что делает

Наблюдать текущую скорость передвижения игрока на поддерживаемых читаемых клиентах. Запрашивается GetUnitSpeed только для player, без проверки других юнитов и без перенаправления на транспорт. Ноль — стоит на месте; положительные конечные дробные скорости допустимы. Отсутствующие, неудачные, ограниченные или повреждённые наблюдения возвращают nil с причиной.

Аргументы

ИмяТипЧто делает
selfRMPlatformАдаптер платформы Rotation Master (неявно при вызове через двоеточие).

Возвращает

1table | nilСвежая читаемая запись с конечной неотрицательной скоростью или nil, если недоступно.
2string | nilПричина по политике или недоступности для наблюдения движения nil.

Издания

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

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

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

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

Пример

local movement = addon.Platform:GetPlayerMovementObservation()
if not movement then return nil end
return movement.speed > 0

Исходный код

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

Platform.player_movement.GetPlayerMovementObservation(self)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if type(GetUnitSpeed)~='function' then return nil,'missing-api' end
    local ok,speed=pcall(GetUnitSpeed,'player')
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(speed) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(speed) then return nil,'restricted-value' end
    if speed==nil then return nil,'movement-data-unavailable' end
    if type(speed)~='number' or speed~=speed or speed==math.huge or speed==-math.huge or speed<0 then return nil,'invalid-api-result' end
    return {speed=speed}

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