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

Platform.runes.validIndex

зависимость

Как вызывать

Platform.runes.validIndex(self, index)

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

Что делает

Validates a rune slot index. Returns true for a readable integer from 1 through 6; otherwise nil with "restricted-value" or "invalid-rune-index".

Аргументы

ИмяТипЧто делает
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
indexanyRune slot index to validate.

Возвращает

1boolean | nilTrue when index is a valid rune slot; nil otherwise.
2string | nilReason when invalid.

Издания

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

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

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

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

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

Зависимости

Исходный код

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

Platform.runes.validIndex(self, index)
    if not self:CanReadValue(index) then return nil,'restricted-value' end
    if not finite(index) or index%1~=0 or index<1 or index>6 then return nil,'invalid-rune-index' end
    return true

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