Platform.actions.spellID

Как вызывать

Platform.actions.spellID(id)

Запишите зависимость Platform.actions.spellID и вызывайте её по этому имени. Вызов через пространство имён не передаёт self: используйте вызов через двоеточие или передайте объект сами.

Что делает

Validates a spell ID argument. Returns true for a readable positive finite integer; otherwise nil with "restricted-value" for a secret value or "invalid-spell" for anything else (including spell names).

Аргументы

Имя	Тип	Что делает
`id`	`any`	Value to validate as a spell ID.

Возвращает

1	`boolean \| nil`	True when id is a valid spell ID; nil otherwise.
2	`string \| nil`	restricted-value or invalid-spell when invalid.

Издания

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

Не читает игровой API напрямую.

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

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

Как его вызывает аддон

Platform.actions.GetSpellRangeState
```
local valid,reason=spellID(id)
```

Зависимости

platform (builtin:Platform/actions.lua:platform)

Исходный код

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

Platform.actions.spellID(id)

    if not platform:CanReadValue(id) then return nil,"restricted-value" end
    if type(id)~="number" or id<1 or id==math.huge or id%1~=0 then return nil,"invalid-spell" end
    return true

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