Skip to content

components.BGMusic

vasili.kostin edited this page Aug 22, 2021 · 13 revisions

Наследуется от Container, и включает в себя все его свойства.

BgMusic - компонент, воспроизводящий зацикленный звук, или музыку. Так как BgMusic является частью иерархии сцены или игрового объекта, при удалении игрового объекта или закрытии сцены, зацикленный звук автоматически остановится. В этом заключается удобство использования экранного BgMusic объекта, для зацикленных звуков и музыки. В добавок, появление на игровом экране модальных диалогов автоматически приглушит или остановит воспроизведение музыки или звука в зависимости от настроек BgMusic объекта. Так же BgMusic позволяет создавать модальные диалоги, или даже фейдеры со своей фоновой музыкой. Thing-Engine автоматически определит какую именно музыку воспроизводить, а какую остановить в каждый момент времени.

Редактируемые свойства:

intro

Тип: String

Вступление. Указывает на звуковой файл, который будет воспроизводиться один раз в начале данной музыки. В редакторе свойств данное поле представляет из себя выпадающий список со всеми имеющимися в проекте звуками.


loop

Тип: String

Петля. Указывает на звуковой файл, который будет воспроизводиться зациклено, после окончания вступления, если вступление intro указано.


isPlaying

Тип: Boolean

Включение/выключение данного звука.


volume

Тип: Number

Громкость воспроизведения для данного звука. Реальная громкость будет зависеть так же от значения глобальной переменной game.Sound.musicVol, либо от переменной, указанной разработчиком в поле globalVolumePath


globalVolumePath

Тип: data-path

Данное поле указывает путь к переменной javascript (Подробнее: Data-Path редактор). Значение указанной переменной будет использоваться как глобальный регулятор громкости. По умолчанию глобальная громкость берется из переменной game.Sound.musicVol, однако, если BgMusic объект используется в качестве зацикленного звукового эффекта для некоторого игрового объекта, то правильно установить значение globalVolumePath равным 'game.Sound.soundsVol', что привяжет глобальную громкость данного звука к глобальной настройке громкости для звуковых эффектов. Подробнее класс Sound


fadeIn

Тип: Number

Скорость нарастания звука в секундах, при его старте. В том случае, если вступление intro для данного BGMusic объекта задано, то при старте воспроизведения фейд не будет применен, так как предполагается, что intro всегда имеет естественное вступление.


fadeOut

Тип: Number

Скорость затухания звука в секундах, при его остановке.


volumeUnderModals

Тип: Number

Уровень громкости, который будет задан данному звуку, в случае если сцена на которой он находится будет перекрыта модальным диалогом. В том случае если модальный диалог содержит свой собственный BGMusic объект, то все перекрытые таким диалогом звуки остановятся полностью. В случае, если данный BGMusic объект используется как зацикленный звуковой эффект, то правильно устанавливать его volumeUnderModals равным нулю.


onIntroFinish

Тип: call

Поле, позволяющее привязать действие, которое будет вызываться при завершении воспроизведения вступления intro. Подробнее см. Callback редактор


dynamicPreloading

Тип: Boolean

Установка данного поля в true, отключает предварительную загрузку звуковых файлов перед входом на сцену. Сцена начнет выполняться без музыки, а как только звуковые файлы загрузятся с сервера, музыка автоматически начнет воспроизведение. Подробнее: Отложенная загрузка звуковых ресурсов.


Методы:

setVolume(volume : Number)

Установка громкости для данного BGMusic объекта. Использование этого метода равносильно .volume = value. Метод введен для возможности управлять громкостью из колбеков кнопок или из ключевых кадров таймлана MovieClip.


play(fade : Number | undefined)

Старт воспроизведения. Переводит isPlaying в true;


stop(fade : Number | undefined)

Остановка воспроизведения. Переводит isPlaying в false;


resetPosition()

Сбрасывает текущую позицию воспроизведения в самое начало. Метод stop только приостанавливает воспроизведение, без сброса позиции.

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

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

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

Свойства, унаследованные от Container

Компоненты

Настройки звука

Clone this wiki locally