SoundAPI — различия между версиями

ГлавнаяInnerCoreLibsSoundAPI — различия между версиями
Строка 159: Строка 159:
 
</div> </div>
 
</div> </div>
  
 +
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
=== MultiSound ===
 
=== MultiSound ===
Строка 165: Строка 166:
  
 
Для создания такого плеера нужен конструктор MultiSound()
 
Для создания такого плеера нужен конструктор MultiSound()
−
<syntaxhighlight lang="JavaScript">var mySounds = new MultiSound([
+
<syntaxhighlight lang="JavaScript">var mySounds = new MultiSound([{
−
     {
+
     src:"mySound.ogg"
−
       src:"mySound.ogg"
+
},
−
   },
+
{
−
    {
+
    src:"mySound2.ogg",
−
       src:"mySound2.ogg",
+
    volume:0.5
−
        volume:0.5
+
}]);</syntaxhighlight>
−
   }
 
−
]);</syntaxhighlight>
 
  
 
Конструктор принимает один параметр - массив с объектами настроек для каждого звука
 
Конструктор принимает один параметр - массив с объектами настроек для каждого звука
Строка 186: Строка 185:
 
Для отсановки -&nbsp;'''stop()'''
 
Для отсановки -&nbsp;'''stop()'''
 
<syntaxhighlight lang="JavaScript">mySounds.stop();</syntaxhighlight>
 
<syntaxhighlight lang="JavaScript">mySounds.stop();</syntaxhighlight>
 +
 +
Класс имеет поле&nbsp;components -&nbsp; массив звуков в виде классов Sound&nbsp;
 +
 +
Пример
 +
<syntaxhighlight lang="JavaScript">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();
 +
});</syntaxhighlight>
 +
 +
==== Все методы класса ====
 +
 +
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 +
|-
 +
| style="text-align: center;" | Метод
 +
| style="text-align: center;" | Аргументы
 +
| style="text-align: center;" | Описание метода
 +
|-
 +
| style="text-align: center;" | setInEntity(Entity entity, int radius)
 +
| style="text-align: center;" | entity - Сущность<br/> radius - радиус слышимости звука (Больше 2)
 +
| style="text-align: center;" | Установить сущность источником звука&nbsp;
 +
|-
 +
| style="text-align: center;" | setInBlock(int x,int y,int z,int radius)
 +
| style="text-align: center;" | x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
 +
| style="text-align: center;" | Устанавливает источник звука по координатам
 +
|-
 +
| style="text-align: center;" | setInPlayer()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
 +
|-
 +
| style="text-align: center;" | setLooping(bool looping)
 +
| style="text-align: center;" | looping - Повторное воспроизведение
 +
| style="text-align: center;" | Повторное воспроизведение
 +
|-
 +
| style="text-align: center;" | addVolume(float volume)
 +
| style="text-align: center;" | volume - Уровень громкости
 +
| style="text-align: center;" | Изменение громкомти плеера
 +
|-
 +
| style="text-align: center;" | play()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Воспроизвести
 +
|-
 +
| style="text-align: center;" | pause()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Приостановить воспроизведение
 +
|-
 +
| style="text-align: center;" | reset()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Сбросить плеер
 +
|-
 +
| style="text-align: center;" | stop()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Остановить
 +
|}
  
 
&nbsp;
 
&nbsp;
 
</div>
 
</div>

Версия 22:46, 26 июня 2018

SoundAPI - библиотека, упрощающая работу со звуком.

Загрузка

Версия Ссылка Список изменений
1 Скачать
  • Первая версия
2 Скачать
  • Добавлен класс MultiSound
  • Добавлены методы setInEntity и setVolume для класса Sound

Условия использования

  • Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
  • Запрещено изменение кода библиотеки
  • Запрещено явное копирование кода в другие библиотеки или моды 

Используя данный продукт вы автоматически соглашаетесь с этими правилами

Документация

Импорт библиотеки 

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 - Сущность
radius - радиус слышимости звука (Больше 2)

Установить сущность источником звука 
1 setInBlock(int x,int y,int z,int radius)

x, y, z - координаты
radius - радиус слышимости звука (Больше 2)

Устанавливает источник звука по координатам
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() - Остановить

 

Источник — «https://wiki.mineprogramming.org/index.php?title=InnerCore/Libs/SoundAPI&oldid=1599»
Навигация
Инструменты