SoundGroup¶
A SoundGroup is used to manage the volume and sound effects on multiple Sounds at once. Sounds in the SoundGroup will have their volume and effects adjusted by the SoundGroup.
Description¶
A SoundGroup is used to manage the volume and effects on multiple
Sounds at once. Every sound in the sound group will have its
volume adjusted by the group's Volume property which
acts as a multiplier, meaning a Sound with volume 0.5 assigned to a
SoundGroup with a volume of 0.5 will have an effective volume of
0.25.
If the SoundGroup has any SoundEffects as children, those effects will be applied to all of the Sounds in the group.
Note that a Sound must be added to a SoundGroup by setting its SoundGroup property, not by simply parenting the Sound to the SoundGroup. A Sound can only belong to one SoundGroup at a time, although you can nest groups as outlined here.
See Sound Groups for further details on working with the SoundGroup class.
Inheritance¶
Object → Instance → SoundGroup
Nova inheritance: Instance → SoundGroup
Properties¶
Volume Supported Property The volume multiplier applied to Sounds that are in the SoundGroup.
The volume multiplier applied to Sounds that are in the SoundGroup.
The volume multiplier applied to Sounds which belong to the
SoundGroup. Value can range from 0 to 10.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
Roblox reference: SoundGroup
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.