Class: Sound

SG2D.Sound() → {SG2D.Sound}

new Sound() → {SG2D.Sound}

Звуки и музыка. Поддержка 2D окружения

Source:
Returns:
Type
SG2D.Sound

Methods

load(optionsopt, propertiesopt) → {Promise}

Загрузчик звуковой библиотеки и установщик параметров. SG2D.Sound.load() можно вызывать много раз для загрузки индивидуальной конфигурации, например, для каждого уровня игры.

Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Настройки путей

Properties
Name Type Attributes Default Description
config object | string <optional>
 "./res/sound.json"

Объект конфигурации или путь к JSON-файлус конфигурацией
music_dir string <optional>
 "./res/music/"

Основная директория с музыкой
sounds_dir string <optional>
 "./res/sounds/"

Основная директория со звуками
library_pathfile string <optional>
 "./libs/pixi/pixi-sound.js"

Путь к файлу библиотеки PIXI.Sound применяется только при первой передаче параметра
properties object <optional>
 {}

Начальные параметры звука

Properties
Name Type Attributes Default Description
sounds boolean <optional>
 true

Включить звуки
music boolean <optional>
 true

Включить музыку
musicVolume number <optional>
 100

Громкость музыки от 0 до 100
soundsVolume number <optional>
 100

Громкость звуков от 0 до 100
muteOnLossFocus boolean <optional>
 true

Выключать звук при потере фокуса приложения
volumeDecreaseDistance number <optional>
 0

Громкость звука зависит от расстояния до источника звука
environment2D boolean <optional>
 true

Включить 2D звуковое окружение
bass boolean <optional>
 false

Усиленные низкие частоты
view string <optional>
 void 0

Текущий view
Source:
Returns:
Type
Promise

musicPlay(viewcodeopt, optionsopt, strictopt) → {boolean}

Запуск проигрывания музыки

Parameters:
Name Type Attributes Default Description
viewcode string | bool <optional>
 true

Код страницы или true. Если true, то воспроизводится текущая музыка.
options object <optional>
 {}

Параметры переданные в метод play(), например громкость звука, скорость воспроизведения, время начала и окончания.
strict boolean <optional>
 false

При true если мелодия не загружена, то консоль выдаст ошибку.
Source:
Returns:

true, если успешно

Type
boolean

play(Sound, config_or_tile, tile) → {object}

Play sound

Parameters:
Name Type Description
Sound string | object

name or base sound object from sounds.json
config_or_tile object

Sound settings overriding basic sounds.json or Tile instance
tile object

If a tile is specified, then position is taken from it to calculate the distance and sound volume
Source:
Returns:

Экземпляр звука PIXI Sound

Type
object