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

Строка 64: Строка 64:
 
</div>
 
</div>
  
 +
<div class="mw-parser-output">
 
=== Все методы класса: ===
 
=== Все методы класса: ===
  
 
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 
|-
 
|-
| style="text-align: center; width: 216px;" | Метод
+
| style="text-align: center; width: 75px;" | Версия API
 +
| style="text-align: center; width: 219px;" | Метод
 
| style="text-align: center; width: 331px;" | Аргументы
 
| style="text-align: center; width: 331px;" | Аргументы
 
| style="text-align: center; width: 361px;" | Описание метода
 
| style="text-align: center; width: 361px;" | Описание метода
 
|-
 
|-
| style="text-align: center; width: 216px;" | setInBlock(int x,int y,int z,int radius)
+
| style="text-align: center; width: 75px;" | 2
 +
| style="text-align: center; width: 219px;" | setInEntity(Entity entity, int radius)
 +
| style="text-align: center; width: 331px;" |
 +
entity - Сущность<br/> radius - радиус слышимости звука (Больше 2)
 +
 
 +
| style="text-align: center; width: 361px;" | Установить сущность источником звука&nbsp;
 +
|-
 +
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" | setInBlock(int x,int y,int z,int radius)
 
| style="text-align: center; width: 331px;" |  
 
| style="text-align: center; width: 331px;" |  
 
x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
 
x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
Строка 78: Строка 88:
 
| style="text-align: center; width: 361px;" | Устанавливает источник звука по координатам
 
| style="text-align: center; width: 361px;" | Устанавливает источник звука по координатам
 
|-
 
|-
| style="text-align: center; width: 216px;" | setInPlayer()
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" | setInPlayer()
 
| style="text-align: center; width: 331px;" | -&nbsp;
 
| style="text-align: center; width: 331px;" | -&nbsp;
 
| style="text-align: center; width: 361px;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
 
| style="text-align: center; width: 361px;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
 
|-
 
|-
| style="text-align: center; width: 216px;" | setOnCompletion(function event)
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" | setOnCompletion(function event)
 
| style="text-align: center; width: 331px;" | event - Событие происходящее при окончании воспроизведения
 
| style="text-align: center; width: 331px;" | event - Событие происходящее при окончании воспроизведения
 
| style="text-align: center; width: 361px;" | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
 
| style="text-align: center; width: 361px;" | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
 
|-
 
|-
| style="text-align: center; width: 216px;" | setSource(string fileName)
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" | setSource(string fileName)
 
| style="text-align: center; width: 331px;" | fileName - Название файла
 
| style="text-align: center; width: 331px;" | fileName - Название файла
 
| style="text-align: center; width: 361px;" | Установить файл для воспроизведения из директории мода
 
| style="text-align: center; width: 361px;" | Установить файл для воспроизведения из директории мода
 
|-
 
|-
| style="text-align: center; width: 216px;" | setLooping(bool looping)
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" |
 +
setLooping(bool looping)
 +
 
 
| style="text-align: center; width: 331px;" | looping - Повторное воспроизведение
 
| style="text-align: center; width: 331px;" | looping - Повторное воспроизведение
 
| style="text-align: center; width: 361px;" | Повторное воспроизведение
 
| style="text-align: center; width: 361px;" | Повторное воспроизведение
 
|-
 
|-
| style="text-align: center; width: 216px;" | play()
+
| style="text-align: center; width: 75px;" | 2
 +
| style="text-align: center; width: 219px;" |
 +
setVolume(float volume)
 +
 
 +
| style="text-align: center; width: 331px;" | volume - Уровень громкости(От 0 до 1)
 +
| style="text-align: center; width: 361px;" | Установить громкость звука
 +
|-
 +
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" |
 +
play()
 +
 
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 361px;" | Воспроизвести
 
| style="text-align: center; width: 361px;" | Воспроизвести
 
|-
 
|-
| style="text-align: center; width: 216px;" | pause()
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" | pause()
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 361px;" | Приостановить воспроизведение
 
| style="text-align: center; width: 361px;" | Приостановить воспроизведение
 
|-
 
|-
| style="text-align: center; width: 216px;" | reset()
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" |
 +
reset()
 +
 
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 361px;" | Сбросить плеер
 
| style="text-align: center; width: 361px;" | Сбросить плеер
 
|-
 
|-
| style="text-align: center; width: 216px;" | stop()
+
| style="text-align: center; width: 75px;" | 1
 +
| style="text-align: center; width: 219px;" |
 +
stop()
 +
 
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 331px;" | -
 
| style="text-align: center; width: 361px;" | Остановить
 
| style="text-align: center; width: 361px;" | Остановить
 
|}
 
|}
 +
 +
</div>
 
</div>
 
</div>

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

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

Загрузка

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

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

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

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

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

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

IMPORT("SoundAPI")

Для создания новго плеера необходимо использовать конструктор 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()

- Остановить