SoundGroup

SoundGroup : Instance

Overview

SoundGroup is an object that lets you control multiple sounds collectively.

To associate a Sound with a specific group, you must set the SoundGroup property directly. Simply parenting a Sound under a SoundGroup in the hierarchy does not link it to that group.

If you change the SoundGroup while a Sound is playing, or change the SoundGroup's Volume, the change is applied immediately.

Properties

Volume

number

A multiplier applied to the volume of all sounds in the SoundGroup. You can set a value from 0 (minimum) to 10 (maximum). The output volume of every sound in the group is scaled proportionally by this value.

If Volume is 0, sounds linked to this SoundGroup will not be output.

Code Samples

local SoundGroup = script.Parent

SoundGroup.Volume = 0.2

Methods

Events

Last updated