User:Unsane/MirLua/m icolib: Difference between revisions
Jump to navigation
Jump to search
Wishmaster (talk | contribs) (→GetIcon: typo) |
mNo edit summary |
||
Line 1: | Line 1: | ||
Предоставляет | Предоставляет функционал для работы с иконками. <br/> | ||
Подключение модуля: <code>local icolib = require('m_icolib')</code> | Подключение модуля: <code>local icolib = require('m_icolib')</code> | ||
Revision as of 15:07, 14 December 2015
Предоставляет функционал для работы с иконками.
Подключение модуля: 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 exists')
end
RemoveIcon
Удаляет иконку
- Параметры
- name
- Тип: string
- Уникальное название иконки
- Пример
icolib.RemoveIcon('iconUniqueName')