SoundAPI
SoundAPI - библиотека, упрощающая работу со звуком.
Содержание
Загрузка
| Версия | Ссылка | Список изменений |
| 1 | Скачать |
|
| 2 | Скачать |
|
Условия использования
- Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
- Запрещено изменение кода библиотеки
- Запрещено явное копирование кода в другие библиотеки или моды
Используя данный продукт вы автоматически соглашаетесь с этими правилами
Документация
Импорт библиотеки
IMPORT("SoundAPI")
Sound
Для создания новго плеера необходимо использовать конструктор Sound()
var mySound = new Sound("mySound.ogg");
Аргументом является наименование звукого файла из папки sounds/
Для того, что бы запустить звук, нужно вызвать метод play()
mySound.play();
Для отсановки - stop()
mySound.stop();
Пример:
IMPORT("SoundAPI")
var mySound = new Sound("mySound.ogg");
Callback.addCallback("LevelLoaded", function () {
mySound.play();
});
Все методы класса:
| Версия API | Метод | Аргументы | Описание метода |
| 2 | setInEntity(Entity entity, int radius) |
entity - Сущность |
Установить сущность источником звука |
| 1 | setInBlock(int x,int y,int z,int radius) |
x, y, z - координаты |
Устанавливает источник звука по координатам |
| 1 | setInPlayer() | - | Устанавливает источник звука "в игроке" Можно использовать для звуков в меню. |
| 1 | setOnCompletion(function event) | event - Событие происходящее при окончании воспроизведения | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop() |
| 1 | setSource(string fileName) | fileName - Название файла | Установить файл для воспроизведения из директории мода |
| 1 |
setLooping(bool looping) |
looping - Повторное воспроизведение | Повторное воспроизведение |
| 2 |
setVolume(float volume) |
volume - Уровень громкости(От 0 до 1) | Установить громкость звука |
| 1 |
play() |
- | Воспроизвести |
| 1 | pause() | - | Приостановить воспроизведение |
| 1 |
reset() |
- | Сбросить плеер |
| 1 |
stop() |
- | Остановить |
MultiSound
Класс MultiSound подходит для работы с несколькими звуками, зависимых друг от друга.
Для создания такого плеера нужен конструктор MultiSound()
var mySounds = new MultiSound([{
src:"mySound.ogg"
},
{
src:"mySound2.ogg",
volume:0.5
}]);
Конструктор принимает один параметр - массив с объектами настроек для каждого звука
- src - название звукового файла
- volume - громкомсть звука
Для того, что бы запустить плеер, нужно вызвать метод play()
mySounds.play();
Для отсановки - stop()
mySounds.stop();
Класс имеет поле components - массив звуков в виде классов Sound
Пример
IMPORT("SoundAPI");
var mySounds = new MultiSound([{
src:"mySound.ogg"
},
{
src:"mySound2.ogg",
volume:.5
}]);
mySounds.components[0].setVolume(.9);
Callback.addCallback("LevelLoaded", function () {
mySounds.play();
});
Все методы класса
| Метод | Аргументы | Описание метода |
| setInEntity(Entity entity, int radius) | entity - Сущность radius - радиус слышимости звука (Больше 2) |
Установить сущность источником звука |
| setInBlock(int x,int y,int z,int radius) | x, y, z - координаты radius - радиус слышимости звука (Больше 2) |
Устанавливает источник звука по координатам |
| setInPlayer() | - | Устанавливает источник звука "в игроке" Можно использовать для звуков в меню. |
| setLooping(bool looping) | looping - Повторное воспроизведение | Повторное воспроизведение |
| addVolume(float volume) | volume - Уровень громкости | Изменение громкомти плеера |
| play() | - | Воспроизвести |
| pause() | - | Приостановить воспроизведение |
| reset() | - | Сбросить плеер |
| stop() | - | Остановить |