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

Строка 22: Строка 22:
  
 
Используя данный продукт вы автоматически соглашаетесь с этими правилами
 
Используя данный продукт вы автоматически соглашаетесь с этими правилами
 +
<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">
Строка 31: Строка 32:
 
== Документация ==
 
== Документация ==
  
Для создания новго плеера&nbsp;необходимо использовать конструктор Sound()
+
Для создания новго плеера&nbsp;необходимо использовать конструктор '''Sound()'''
 
<pre>var mySound = new Sound("mySound.ogg");</pre>
 
<pre>var mySound = new Sound("mySound.ogg");</pre>
  
Аргументом является наименование звукого файла из папки sounds/
+
Аргументом является наименование звукого файла из папки '''''sounds/'''''
  
Для того, что бы запустить звук, нужно вызвать метод play()
+
Для того, что бы запустить звук, нужно вызвать метод'''play()'''
 
<pre>mySound.play();</pre>
 
<pre>mySound.play();</pre>
  
Для отсановки - stop()
+
Для отсановки - '''stop()'''
 
<pre>mySound.stop();
 
<pre>mySound.stop();
 
</pre>
 
</pre>
  
Пример:
+
=== Пример: ===
 
<syntaxhighlight lang="JavaScript">var mySound = new Sound("mySound.ogg");
 
<syntaxhighlight lang="JavaScript">var mySound = new Sound("mySound.ogg");
  
Строка 49: Строка 50:
 
    mySound.play();
 
    mySound.play();
 
});</syntaxhighlight>
 
});</syntaxhighlight>
 +
 +
=== Все методы конструктора: ===
  
 
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 
|-
 
|-
| style="text-align: center;" | Метод
+
| style="text-align: center; width: 216px;" | Метод
| style="text-align: center;" | Аргументы
+
| style="text-align: center; width: 331px;" | Аргументы
| style="text-align: center;" | Описание метода
+
| style="text-align: center; width: 361px;" | Описание метода
 
|-
 
|-
| style="text-align: center;" | setInBlock(int x,int y,int z,int radius)
+
| style="text-align: center; width: 216px;" | setInBlock(int x,int y,int z,int radius)
| style="text-align: center;" |  
+
| style="text-align: center; width: 331px;" |  
 
x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
 
x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
  
| style="text-align: center;" | Устанавливает источник звука по координатам
+
| style="text-align: center; width: 361px;" | Устанавливает источник звука по координатам
 
|-
 
|-
| style="text-align: center;" | setInPlayer()
+
| style="text-align: center; width: 216px;" | setInPlayer()
| style="text-align: center;" | -&nbsp;
+
| style="text-align: center; width: 331px;" | -&nbsp;
| style="text-align: center;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
+
| style="text-align: center; width: 361px;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
 
|-
 
|-
| style="text-align: center;" | setOnCompletion(function event)
+
| style="text-align: center; width: 216px;" | setOnCompletion(function event)
| style="text-align: center;" | event - Событие происходящее при окончании воспроизведения
+
| style="text-align: center; width: 331px;" | event - Событие происходящее при окончании воспроизведения
| style="text-align: center;" | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
+
| style="text-align: center; width: 361px;" | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
 
|-
 
|-
| style="text-align: center;" | setSource(string fileName)
+
| style="text-align: center; width: 216px;" | setSource(string fileName)
| style="text-align: center;" | fileName - Название файла
+
| style="text-align: center; width: 331px;" | fileName - Название файла
| style="text-align: center;" | Установить файл для воспроизведения из директории мода
+
| style="text-align: center; width: 361px;" | Установить файл для воспроизведения из директории мода
 
|-
 
|-
| style="text-align: center;" | setLooping(bool looping)
+
| style="text-align: center; width: 216px;" | setLooping(bool looping)
| style="text-align: center;" | looping - Повторное воспроизведение
+
| style="text-align: center; width: 331px;" | looping - Повторное воспроизведение
| style="text-align: center;" | Повторное воспроизведение
+
| style="text-align: center; width: 361px;" | Повторное воспроизведение
 
|-
 
|-
| style="text-align: center;" | play()
+
| style="text-align: center; width: 216px;" | play()
| style="text-align: center;" | -
+
| style="text-align: center; width: 331px;" | -
| style="text-align: center;" | Воспроизвести
+
| style="text-align: center; width: 361px;" | Воспроизвести
 
|-
 
|-
| style="text-align: center;" | pause()
+
| style="text-align: center; width: 216px;" | pause()
| style="text-align: center;" | -
+
| style="text-align: center; width: 331px;" | -
| style="text-align: center;" | Приостановить воспроизведение
+
| style="text-align: center; width: 361px;" | Приостановить воспроизведение
 
|-
 
|-
| style="text-align: center;" | reset()
+
| style="text-align: center; width: 216px;" | reset()
| style="text-align: center;" | -
+
| style="text-align: center; width: 331px;" | -
| style="text-align: center;" | Сбросить плеер
+
| style="text-align: center; width: 361px;" | Сбросить плеер
 
|-
 
|-
| style="text-align: center;" | stop()
+
| style="text-align: center; width: 216px;" | stop()
| style="text-align: center;" | -
+
| style="text-align: center; width: 331px;" | -
| style="text-align: center;" | Остановить
+
| style="text-align: center; width: 361px;" | Остановить
 
|}
 
|}
  
 
&nbsp;&nbsp;
 
&nbsp;&nbsp;
  
&nbsp;</div>
+
&nbsp;</div> </div>
 
</div>
 
</div>

Версия 22:18, 24 июня 2018

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

Загрузка

Версия Ссылка Список изменений
1 Скачать Первая версия

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

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

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

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

Для создания новго плеера необходимо использовать конструктор Sound()

var mySound = new Sound("mySound.ogg");

Аргументом является наименование звукого файла из папки sounds/

Для того, что бы запустить звук, нужно вызвать методplay()

mySound.play();

Для отсановки - stop()

mySound.stop();

Пример:

var mySound = new Sound("mySound.ogg");

Callback.addCallback("LevelLoaded", function () {
    mySound.play();
});

Все методы конструктора:

Метод Аргументы Описание метода
setInBlock(int x,int y,int z,int radius)

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

Устанавливает источник звука по координатам
setInPlayer() Устанавливает источник звука "в игроке"
Можно использовать для звуков в меню.
setOnCompletion(function event) event - Событие происходящее при окончании воспроизведения Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
setSource(string fileName) fileName - Название файла Установить файл для воспроизведения из директории мода
setLooping(bool looping) looping - Повторное воспроизведение Повторное воспроизведение
play() - Воспроизвести
pause() - Приостановить воспроизведение
reset() - Сбросить плеер
stop() - Остановить