SoundConfig <Channel, SName>

Type parameters

• Channel: string = string
• SName: string = string

Index

Properties

• channel
• name
• sound
• volume

Properties

optionalchannel

channel?: Channel

The SoundChannel this sound is routed through, for example 'music' or 'sfx'. Channel volume, mute and effects apply to every sound in the channel. Sounds without a channel route straight to the manager's master output.

optionalname

name?: SName

Optional explicit name for this sound in the manager. If omitted, the sound's own Sound.name (basename-without-extension) is used.

sound

sound: Sound<SName>

optionalvolume

volume?: number

Mix volume [0-1] for this sound, default 1 (full volume). Multiplies with the sound's own volume, its channel volume, and the master volume.