User:Unsane/MirLua/m icolib

Предоставляет фукционал для работы с иконками.
Подключение модуля: local icolib = require('m_icolib')

AddIcon

Регистрирует иконку

Параметры

name

Тип: string

Уникальное название иконки

description

Тип: string

Описание

section

Тип: string

Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)

Результат

Тип: light userdata

Возвращает дескриптор иконки, если иконка была успешно зарегистрирована, иначе nil

Пример

local hIcon = icolib.AddIcon('iconUniqueName', 'My super icon')

GetIcon

Возвращает дескриптор иконки

Параметры

name

Тип: string

Уникальное название иконки

Результат

Тип: boolean

Возвращает Возвращает дескриптор иконки, если иконка была найдена, иначе nil

Пример

if icolib.GetIcon('iconUniqueName') then
  print('Icon iconUniqueName is exists')
end

RemoveIcon

Удаляет иконку

Параметры

name

Тип: string

Уникальное название иконки

Результат

Тип: boolean

Возвращает true, если иконка была удалена, иначе false

Пример

icolib.RemoveIcon('iconUniqueName')