Platform.spells.identifier

Как вызывать

Platform.spells.identifier(value, idOnly)

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

Что делает

Validates a spell argument. Accepts a readable positive finite integer spell ID or, unless idOnly is true, a nonempty spell name string. Returns true, or false with "restricted-value" for a secret value or "invalid-spell" for anything else.

Аргументы

Имя	Тип	Что делает
`value`	`any`	Spell ID or name to validate.
`idOnly`	`boolean \| nil`	True accepts numeric spell IDs only and rejects names.

Возвращает

1	`boolean`	True when value is acceptable; false otherwise.
2	`string \| nil`	restricted-value or invalid-spell when rejected.

Издания

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

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

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

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

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

Platform.spells.GetSpellCharges
```
local valid,reason=identifier(spell)
```
Platform.spells.GetSpellCooldown
```
local valid, reason = identifier(spell)
```

Platform.spells.IsAutoRepeatActive

local valid,reason=identifier(spellID,true)

Platform.spells.cooldownValues
```
local valid,reason=identifier(spell)
```

Зависимости

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

Исходный код

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

Platform.spells.identifier(value, idOnly)

    if not platform:CanReadValue(value) then return false, "restricted-value" end
    if type(value) == "number" and value > 0 and value < math.huge and value % 1 == 0 then return true end
    if not idOnly and type(value) == "string" and #value > 0 then return true end
    return false, "invalid-spell"

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