Skip to content

utils.Sound

vasili.kostin edited this page Aug 27, 2021 · 11 revisions

Функции для работы со Звуком

Перед использованием модуля Sound в коде javascript необходимо импортировать его следующим образом:

import Sound from "thing-editor/js/engine/utils/sound.js";

В редакторе колбеков данный модуль доступен по пути 'Sound'


Статические свойства:

Sound.soundsVol : Number

Глобальный уровень громкости звуков, воспроизводимых через вызов метода Sound.play. Допустимое значение от 0 до 1. Данное свойство используется в игровом меню для настройки громкости звуковых эффектов в игре. Значении по умолчанию для этого свойства задается в настройках проекта defaultSoundsVol


Sound.musicVol : Number

Глобальный уровень громкости музыки, воспроизводимой через компонент BGMusic. Допустимое значение от 0 до 1. Данное свойство используется в игровом меню для настройки громкости фоновой музыки в игре. Значении по умолчанию для этого свойства задается в настройках проекта defaultMusVol


Sound.fullVol : Number

Глобальный уровень громкости музыки и звука. Допустимое значение от 0 до 1. Данное свойство может использоваться в игре, не имеющей отдельной настройки громкости музыки, использующей один регулятор громкости для всего звука сразу. Присвоение значения этому свойству устанавливает значение для soundsVol и musicVol одновременно.


Sound.musicEnabled : Boolean

Включает/отключает музыку.

При отключении музыки значение поля musicVol устанавливается равным 0, при этом старое значение сохраняется в хранилище игровых настроек под именем musicVolEnabling. При включении музыки сохраненное значение громкости восстанавливается.


Sound.soundEnabled : Boolean

Включает/отключает звуковые эффекты.

При отключении звуковых эффектов значение поля soundsVol устанавливается равным 0, при этом старое значение сохраняется в хранилище игровых настроек под именем soundsVolEnabling. При включении звуковых эффектов сохраненное значение громкости восстанавливается.


Sound.isSoundsLockedByBrowser : Boolean

При старте игры, с большей вероятностью воспроизведение звука будет заблокировано браузером, до первого клика игроком. Это связано с политикой, запрещающей нежелательные звуки на веб страницах. Если Sound.isSoundsLockedByBrowser имеет значение true, значит воспроизведение звука действительно недоступно. Все экземпляры BGMusic будут временно приостановлены, и автоматически запустятся при первом клике игрока. При этом Sound.isSoundsLockedByBrowser примет значение false. Однако в ряде обстоятельств воспроизведение звуков доступно изначально, в этом случае Sound.isSoundsLockedByBrowser никогда не будет иметь значения true.


Статические методы:

Sound.play(soundId : String, volume = 1.0, rate = 1.0, seek = 0.0, multiInstanced = false)

Воспроизводит звуковой эффект с именем soundId. Все доступные в проекте звуки можно посмотреть в окне игрового редактора Список звуковых эффектов. При воспроизведении звука предыдущий звук с тем же soundId прерывается. Повторный вызов метода с одним и тем-же soundId за один игровой кадр будет проигнорирован.

volume - громкость с которой будет воспроизведен звуковой эффект. Допустимое значение от 0 до 1. Реальная громкость будет зависеть, дополнительно, от глобального уровня громкости звуковых эффектов soundsVol

rate - скорость с которой будет воспроизведен звуковой эффект. 1 - нормальная скорость воспроизведения.

seek - Время в секундах, начиная с которого будет воспроизведен звуковой эффект. 0 - воспроизведет звук с самого начала.

multiInstanced - true воспроизводит звук не прерывая предыдущий звук с тем же soundId.


Sound.setSoundsVol (vol : Number)

Устанавливает значение для soundsVol. Метод добавлен для возможности установить значение громкости из редактируемого колбека


Sound.setMusicVol (vol : Number)

musicEnabled Устанавливает значение для musicVol. Метод добавлен для возможности установить значение громкости музыки из редактируемого колбека


Sound.toggleMusic ()

Инвертирует значение поля musicEnabled.


Sound.toggleSounds ()

Инвертирует значение поля soundEnabled.


Sound.toggleFullSound ()

Инвертирует значение полей soundEnabled и musicEnabled одновременно.

<- Предыдущая страница Следующая страница ->

Связанные темы:

Общая информация для Javascript разработчика

Библиотека звуков

Clone this wiki locally