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

Строка 1: Строка 1:
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
+
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
 
'''SoundAPI&nbsp;'''- библиотека, упрощающая работу со звуком.
 
'''SoundAPI&nbsp;'''- библиотека, упрощающая работу со звуком.
<div class="mw-parser-output">
+
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
 
== Загрузка ==
 
== Загрузка ==
  
Строка 24: Строка 16:
  
 
|-
 
|-
| style="width: 47px; text-align: center;" | 2
+
| style="width: 47px; text-align: center;" | '''2'''
 
| style="width: 52px; text-align: center;" | Скачать
 
| style="width: 52px; text-align: center;" | Скачать
 
| style="width: 445px; text-align: center;" |  
 
| style="width: 445px; text-align: center;" |  
Строка 31: Строка 23:
  
 
|}
 
|}
</div>
+
</div>  
 
 
 
== Условия использования ==
 
== Условия использования ==
  
Строка 40: Строка 31:
  
 
Используя данный продукт&nbsp;вы автоматически соглашаетесь с этими правилами
 
Используя данный продукт&nbsp;вы автоматически соглашаетесь с этими правилами
<div class="mw-parser-output">
+
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
 
== Документация ==
 
== Документация ==
  
 
Импорт библиотеки
 
Импорт библиотеки
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")</syntaxhighlight>
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")</syntaxhighlight>
 
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
=== Sound ===
 
=== Sound ===
Строка 75: Строка 52:
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
==== Пример: ====
 
==== Пример: ====
 +
 +
&nbsp;
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")
 
var mySound = new Sound("mySound.ogg");
 
var mySound = new Sound("mySound.ogg");
Строка 161: Строка 140:
 
| style="text-align: center; width: 361px;" | Остановить
 
| style="text-align: center; width: 361px;" | Остановить
 
|}
 
|}
</div> </div>
+
</div> </div> <div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
 
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
 
 
=== MultiSound ===
 
=== MultiSound ===
  
 
Класс MultiSound подходит для работы с несколькими звуками, зависимых друг от друга.
 
Класс MultiSound подходит для работы с несколькими звуками, зависимых друг от друга.
  
Для создания такого плеера нужен конструктор MultiSound()
+
Для создания такого плеера нужен конструктор '''MultiSound()'''
 
<syntaxhighlight lang="JavaScript">var mySounds = new MultiSound([{
 
<syntaxhighlight lang="JavaScript">var mySounds = new MultiSound([{
 
     src:"mySound.ogg"
 
     src:"mySound.ogg"
Строка 181: Строка 156:
 
Конструктор принимает один параметр - массив с объектами настроек для каждого звука
 
Конструктор принимает один параметр - массив с объектами настроек для каждого звука
  
*src - название звукового файла  
+
*'''src '''- название звукового файла  
*volume - громкомсть звука  
+
*'''volume '''- громкомсть звука  
  
 
Для того, что бы запустить плеер, нужно вызвать метод&nbsp;'''play()'''
 
Для того, что бы запустить плеер, нужно вызвать метод&nbsp;'''play()'''
Строка 194: Строка 169:
  
 
==== Пример ====
 
==== Пример ====
 +
 +
&nbsp;
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI");
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI");
  
Строка 253: Строка 230:
 
| style="text-align: center;" | Остановить
 
| style="text-align: center;" | Остановить
 
|}
 
|}
 
+
</div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>
&nbsp; </div>
 
</div>
 

Версия 23:59, 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() - Остановить