Текущая версия |
Ваш текст |
Строка 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"><div class="mw-parser-output"> |
| '''SoundAPI '''- библиотека, упрощающая работу со звуком. | | '''SoundAPI '''- библиотека, упрощающая работу со звуком. |
− | <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"> |
| == Загрузка == | | == Загрузка == |
| | | |
− | {| border="1" cellpadding="1" cellspacing="1" style="width: 605px;" | + | {| border="1" cellpadding="1" cellspacing="1" style="width: 435px;" |
| |- | | |- |
− | | style="width: 47px; text-align: center;" | '''Версия''' | + | | style="width: 91px; text-align: center;" | Версия |
− | | style="width: 52px; text-align: center;" | '''Ссылка''' | + | | style="width: 97px; text-align: center;" | Ссылка |
− | | style="width: 483px; text-align: center;" | '''Список изменений''' | + | | style="width: 231px; text-align: center;" | Список изменений |
− | |-
| |
− | | style="width: 47px; text-align: center;" | '''1'''
| |
− | | style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2046 Скачать]
| |
− | | style="width: 483px; text-align: center;" |
| |
− | *Первая версия
| |
− | | |
− | |-
| |
− | | style="width: 47px; text-align: center;" | '''2'''
| |
− | | style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2048 Скачать]
| |
− | | style="width: 483px; text-align: center;" |
| |
− | *Добавлен класс MultiSound
| |
− | *Добавлены методы setInEntity и setVolume для класса Sound
| |
− | | |
− | |-
| |
− | | style="width: 47px; text-align: center;" | '''2.1'''
| |
− | | style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2134 Скачать]
| |
− | | style="width: 483px; text-align: center;" |
| |
− | *Добавлен метод destroy
| |
− | *Добавлены методы isPlaying и isLooping для класса Sound
| |
− | *Исправлена ошибка при создании пустого плеера
| |
− | *Исправлена формула зависимости громкости звука от расстояния
| |
− | | |
− | |-
| |
− | | style="width: 47px; text-align: center;" | '''2.2'''
| |
− | | style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2146 Скачать]
| |
− | | style="width: 483px; text-align: center;" |
| |
− | *Исправлена ошибка из-за которой звук не менял свою громкость вне зависимости к чему он привязан.
| |
− | *Возвращена предыдущая формула громкости из-за неправильной работы предыдущей.
| |
− | | |
| |- | | |- |
− | | style="width: 47px; text-align: center;" | '''2.3''' | + | | style="width: 91px; text-align: center;" | '''1''' |
− | | style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2156 Скачать] | + | | style="width: 97px; text-align: center;" | Скачать |
− | | style="width: 483px; text-align: center;" | | + | | style="width: 231px; text-align: center;" | Первая версия |
− | *Исправлена ошибка вызванная глобальностью библиотеки.
| |
− | *Громкость плеера зависит от громкости в настройках игры.
| |
− | | |
| |} | | |} |
− | </div> </div>
| + | </div> |
| == Условия использования == | | == Условия использования == |
| | | |
Строка 54: |
Строка 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"><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"> |
| == Документация == | | == Документация == |
| | | |
− | Импорт библиотеки
| + | Для создания новго плеера необходимо использовать конструктор Sound() |
− | <syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")</syntaxhighlight> | + | <pre>var mySound = new Sound("mySound.ogg");</pre> |
− | <div class="mw-parser-output"><div class="mw-parser-output">
| |
− | === Sound ===
| |
| | | |
− | Для создания новго плеера необходимо использовать конструктор '''Sound()'''
| + | Аргументом является наименование звукого файла из папки sounds/ |
− | <syntaxhighlight lang="JavaScript">var mySound = new Sound();</syntaxhighlight>
| |
| | | |
− | Затем зададим ему файл, который нужно воспроизводить
| + | Для того, что бы запустить звук, нужно вызвать метод play() |
− | <syntaxhighlight lang="JavaScript">mySound.setSource("mySound.ogg");</syntaxhighlight> | + | <pre>mySound.play();</pre> |
| | | |
− | Аргументом является наименование звукого файла из папки '''''sounds/'''''
| + | Для отсановки - stop() |
| + | <pre>mySound.stop(); |
| + | </pre> |
| | | |
− | Это можно сократить в одну строчку
| + | Пример: |
− | <syntaxhighlight lang="JavaScript">var mySound = new Sound("mySound.ogg");</syntaxhighlight>
| + | <syntaxhighlight lang="JavaScript">var mySound = new Sound("mySound.ogg"); |
− | | |
− | Для того, что бы запустить звук, нужно вызвать метод '''play()'''
| |
− | <syntaxhighlight lang="JavaScript">mySound.play();</syntaxhighlight>
| |
− | | |
− | Для отсановки - '''stop()'''
| |
− | <syntaxhighlight lang="JavaScript">mySound.stop();
| |
− | </syntaxhighlight>
| |
− | <div class="mw-parser-output">
| |
− | ==== Пример: ====
| |
− | <syntaxhighlight lang="JavaScript">IMPORT("SoundAPI") | |
− | var mySound = new Sound();
| |
− | mySound.setSource("mySound.ogg");
| |
− | //var mySound = new Sound("mySound.ogg");
| |
| | | |
| Callback.addCallback("LevelLoaded", function () { | | Callback.addCallback("LevelLoaded", function () { |
| mySound.play(); | | mySound.play(); |
− | });
| |
− | </syntaxhighlight>
| |
− | </div> <div class="mw-parser-output"><div class="mw-parser-output">
| |
− | ==== Все методы класса: ====
| |
− |
| |
− | {| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
| |
− | |-
| |
− | | style="text-align: center; width: 75px;" | Версия API
| |
− | | style="text-align: center; width: 219px;" | Метод
| |
− | | style="text-align: center; width: 331px;" | Аргументы
| |
− | | style="text-align: center; width: 361px;" | Описание метода
| |
− | |-
| |
− | | style="text-align: center; width: 75px;" | 2.1
| |
− | | style="text-align: center; width: 219px;" | destroy()
| |
− | | style="text-align: center; width: 331px;" | -
| |
− | | style="text-align: center; width: 361px;" | Уничтожить экземпляр Sound
| |
− | |-
| |
− | | style="text-align: center; width: 75px;" | 2.1
| |
− | | style="text-align: center; width: 219px;" | isPlaying()
| |
− | | style="text-align: center; width: 331px;" | -
| |
− | | style="text-align: center; width: 361px;" | Играет ли плеер
| |
− | |-
| |
− | | style="text-align: center; width: 75px;" | 2.1
| |
− | | style="text-align: center; width: 219px;" | isLooping()
| |
− | | style="text-align: center; width: 331px;" | -
| |
− | | style="text-align: center; width: 361px;" | Включен ли повтор у плеера
| |
− | |-
| |
− | | 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;" | Установить сущность источником звука
| |
− | |-
| |
− | | 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;" |
| |
− | x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
| |
− |
| |
− | | style="text-align: center; width: 361px;" | Устанавливает источник звука по координатам
| |
− | |-
| |
− | | style="text-align: center; width: 75px;" | 1
| |
− | | style="text-align: center; width: 219px;" | setInPlayer()
| |
− | | style="text-align: center; width: 331px;" | -
| |
− | | style="text-align: center; width: 361px;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
| |
− | |-
| |
− | | 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: 361px;" | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
| |
− | |-
| |
− | | 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: 361px;" | Установить файл для воспроизведения из директории мода
| |
− | |-
| |
− | | 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: 361px;" | Повторное воспроизведение
| |
− | |-
| |
− | | 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: 361px;" | Воспроизвести
| |
− | |-
| |
− | | 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: 361px;" | Приостановить воспроизведение
| |
− | |-
| |
− | | 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: 361px;" | Сбросить плеер
| |
− | |-
| |
− | | 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: 361px;" | Остановить
| |
− | |}
| |
− | </div> </div> </div> </div>
| |
− | === MultiSound ===
| |
− |
| |
− | Класс MultiSound подходит для работы с несколькими звуками, зависимых друг от друга.
| |
− |
| |
− | Для создания такого плеера нужен конструктор '''MultiSound()'''
| |
− | <syntaxhighlight lang="JavaScript">var mySounds = new MultiSound([{
| |
− | src:"mySound.ogg"
| |
− | },
| |
− | {
| |
− | src:"mySound2.ogg",
| |
− | volume:0.5
| |
− | }]);</syntaxhighlight>
| |
− |
| |
− | Конструктор принимает один параметр - массив с объектами настроек для каждого звука
| |
− |
| |
− | *'''src '''- название звукового файла
| |
− | *'''volume '''- громкомсть звука
| |
− |
| |
− | Для того, что бы запустить плеер, нужно вызвать метод '''play()'''
| |
− | <syntaxhighlight lang="JavaScript">mySounds.play();
| |
− | </syntaxhighlight>
| |
− |
| |
− | Для отсановки - '''stop()'''
| |
− | <syntaxhighlight lang="JavaScript">mySounds.stop();</syntaxhighlight>
| |
− |
| |
− | Класс имеет поле components - массив звуков в виде классов Sound
| |
− |
| |
− | ==== Пример ====
| |
− | <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> | | });</syntaxhighlight> |
− | <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;" | Версия API
| |
| | style="text-align: center;" | Метод | | | style="text-align: center;" | Метод |
| | style="text-align: center;" | Аргументы | | | style="text-align: center;" | Аргументы |
| | style="text-align: center;" | Описание метода | | | style="text-align: center;" | Описание метода |
| |- | | |- |
− | | style="text-align: center;" | 2.1
| |
− | | style="text-align: center;" | destroy()
| |
− | | style="text-align: center;" | -
| |
− | | style="text-align: center;" | ить экземпляр Sound
| |
− | |-
| |
− | | style="text-align: center;" | 2
| |
− | | style="text-align: center;" | setInEntity(Entity entity, int radius)
| |
− | | style="text-align: center;" | entity - Сущность<br/> radius - радиус слышимости звука (Больше 2)
| |
− | | style="text-align: center;" | Установить сущность источником звука
| |
− | |-
| |
− | | style="text-align: center;" | 2
| |
| | style="text-align: center;" | setInBlock(int x,int y,int z,int radius) | | | 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;" | |
| + | x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2) |
| + | |
| | style="text-align: center;" | Устанавливает источник звука по координатам | | | style="text-align: center;" | Устанавливает источник звука по координатам |
| |- | | |- |
− | | style="text-align: center;" | 2
| |
| | style="text-align: center;" | setInPlayer() | | | style="text-align: center;" | setInPlayer() |
− | | style="text-align: center;" | - | + | | style="text-align: center;" | - |
| | style="text-align: center;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню. | | | style="text-align: center;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню. |
| |- | | |- |
− | | style="text-align: center;" | 2 | + | | style="text-align: center;" | setOnCompletion(function event) |
| + | | style="text-align: center;" | event - Событие происходящее при окончании воспроизведения |
| + | | style="text-align: center;" | Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop() |
| + | |- |
| + | | style="text-align: center;" | setSource(string fileName) |
| + | | style="text-align: center;" | fileName - Название файла |
| + | | style="text-align: center;" | Установить файл для воспроизведения из директории мода |
| + | |- |
| | style="text-align: center;" | setLooping(bool looping) | | | style="text-align: center;" | setLooping(bool looping) |
| | style="text-align: center;" | looping - Повторное воспроизведение | | | style="text-align: center;" | looping - Повторное воспроизведение |
| | style="text-align: center;" | Повторное воспроизведение | | | style="text-align: center;" | Повторное воспроизведение |
| |- | | |- |
− | | style="text-align: center;" | 2
| |
− | | style="text-align: center;" | addVolume(float volume)
| |
− | | style="text-align: center;" | volume - Уровень громкости
| |
− | | style="text-align: center;" | Изменение громкомти плеера
| |
− | |-
| |
− | | style="text-align: center;" | 2
| |
| | style="text-align: center;" | play() | | | style="text-align: center;" | play() |
| | style="text-align: center;" | - | | | style="text-align: center;" | - |
| | style="text-align: center;" | Воспроизвести | | | style="text-align: center;" | Воспроизвести |
| |- | | |- |
− | | style="text-align: center;" | 2
| |
| | style="text-align: center;" | pause() | | | style="text-align: center;" | pause() |
| | style="text-align: center;" | - | | | style="text-align: center;" | - |
| | style="text-align: center;" | Приостановить воспроизведение | | | style="text-align: center;" | Приостановить воспроизведение |
| |- | | |- |
− | | style="text-align: center;" | 2
| |
| | style="text-align: center;" | reset() | | | style="text-align: center;" | reset() |
| | style="text-align: center;" | - | | | style="text-align: center;" | - |
| | style="text-align: center;" | Сбросить плеер | | | style="text-align: center;" | Сбросить плеер |
| |- | | |- |
− | | style="text-align: center;" | 2
| |
| | style="text-align: center;" | stop() | | | style="text-align: center;" | stop() |
| | style="text-align: center;" | - | | | style="text-align: center;" | - |
| | 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> </div> </div> </div> </div> </div> </div> </div> </div> | + | |
| + | |
| + | |
| + | </div> |
| + | </div> |