User:Unsane/MirLua/m sounds: Difference between revisions
Jump to navigation
Jump to search
m (→AddSound) |
mNo edit summary |
||
| Line 19: | Line 19: | ||
:: Путь к звуковому файлу | :: Путь к звуковому файлу | ||
;Результат | ;Результат | ||
: Тип: ''' | : Тип: '''boolean''' | ||
: Возвращает | : Возвращает '''true''', если звук был успешно зарегистрирована, иначе '''false''' | ||
;Пример | ;Пример | ||
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}} | {{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}} | ||
===PlaySound=== | ===PlaySound=== | ||
Воcпроизводит звук | Воcпроизводит звук по уникальному названию | ||
;Параметры | ;Параметры | ||
| Line 32: | Line 32: | ||
:: Уникальное название | :: Уникальное название | ||
;Результат | ;Результат | ||
: Тип: ''' | : Тип: '''boolean''' | ||
: Возвращает | : Возвращает '''true''' в случае успешного воспроизведения звука, иначе '''false''' | ||
;Пример | ;Пример | ||
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | {{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | ||
===PlayFile=== | ===PlayFile=== | ||
Воcпроизводит звук из файла | |||
;Параметры | ;Параметры | ||
| Line 45: | Line 45: | ||
:: Путь к файлу | :: Путь к файлу | ||
;Результат | ;Результат | ||
: Тип: ''' | : Тип: '''boolean''' | ||
: Возвращает | : Возвращает '''true''' в случае успешного воспроизведения звука, иначе '''false''' | ||
;Пример | ;Пример | ||
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | {{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | ||
Revision as of 00:53, 26 December 2015
Предоставляет функционал для работы со звуками.
Подключение модуля: local sounds = require('m_sounds')
AddSound
Регистрирует звук
- Параметры
- name
- Тип: string
- Уникальное название
- description
- Тип: string
- Описание
- section
- Тип: string
- Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)
- path
- Тип: string
- Путь к звуковому файлу
- Результат
- Тип: boolean
- Возвращает true, если звук был успешно зарегистрирована, иначе false
- Пример
local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')PlaySound
Воcпроизводит звук по уникальному названию
- Параметры
- name
- Тип: string
- Уникальное название
- Результат
- Тип: boolean
- Возвращает true в случае успешного воспроизведения звука, иначе false
- Пример
sounds.PlaySound('soundUniqueName')PlayFile
Воcпроизводит звук из файла
- Параметры
- path
- Тип: string
- Путь к файлу
- Результат
- Тип: boolean
- Возвращает true в случае успешного воспроизведения звука, иначе false
- Пример
sounds.PlayFile('c:\\lambada.wav')