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

Platform.creature_type.GetUnitCreatureTypeID

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

Как вызывать

addon.Platform:GetUnitCreatureTypeID(unit)

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

Что делает

Наблюдать идентичность существа по второму возвращаемому значению встроенного UnitCreatureType на клиентах с политикой проверки или ограничения. Сначала проверяется точный UnitExists(unit); читаемое false возвращает false без запроса метаданных существа. Для присутствующего юнита нужен читаемый конечный числовой ID; неиспользуемое локализованное название на доступность не влияет. Знаковые, дробные, нулевые и будущие конечные ID сохраняются как известные значения. Отсутствующие, неудачные, nil, ограниченные или повреждённые обязательные факты возвращают nil с причиной. Перечисление существ, сравнение переведённых подписей и долговременный кэш не добавляются.

Аргументы

ИмяТипЧто делает
selfRMPlatformАдаптер платформы Rotation Master (неявно при вызове через двоеточие).
unitstringЧитаемый непустой токен выбранного юнита, передаваемый без изменений единственным аргументом в запросы существования и метаданных существа.

Возвращает

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

Издания

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

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

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

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

Пример

local id = addon.Platform:GetUnitCreatureTypeID("target")
if id == nil then return nil end
-- false (no target) never equals 6, the Undead creature type.
return id == 6

Исходный код

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

Platform.creature_type.GetUnitCreatureTypeID(self, unit)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' 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 native=UnitCreatureType
    if type(native)~='function' then return nil,'missing-api' end
    local observed,_,id=pcall(native,unit)
    if not observed then return nil,'api-error' end
    if not self:CanReadValue(id) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(id) then return nil,'restricted-value' end
    if id==nil then return nil,'unit-creature-type-unavailable' end
    if type(id)~='number' or id~=id or id==math.huge or id==-math.huge then return nil,'invalid-api-result' end
    return id

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