mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
63 lines
2.2 KiB
YAML
63 lines
2.2 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: SoundGroup
|
|
type: class
|
|
memory_category: Internal
|
|
summary: |
|
|
A `Class.SoundGroup` is used to manage the volume and sound effects on
|
|
multiple `Class.Sound|Sounds` at once. `Class.Sound|Sounds` in the SoundGroup
|
|
will have their volume and effects adjusted by the SoundGroup.
|
|
description: |
|
|
A `Class.SoundGroup` is used to manage the volume and effects on multiple
|
|
`Class.Sound|Sounds` at once. Every sound in the sound group will have its
|
|
volume adjusted by the group's `Class.SoundGroup.Volume|Volume` property which
|
|
acts as a multiplier, meaning a `Class.Sound` with volume `0.5` assigned to a
|
|
`Class.SoundGroup` with a volume of `0.5` will have an effective volume of
|
|
`0.25`.
|
|
|
|
If the `Class.SoundGroup` has any `Class.SoundEffect|SoundEffects` as
|
|
children, those effects will be applied to all of the `Class.Sound|Sounds` in
|
|
the group.
|
|
|
|
Note that a `Class.Sound` must be added to a `Class.SoundGroup` by setting its
|
|
`Class.Sound.SoundGroup|SoundGroup` property, not by simply parenting the
|
|
`Class.Sound` to the `Class.SoundGroup`. A `Class.Sound` can only belong to
|
|
one `Class.SoundGroup` at a time, although you can nest groups as outlined
|
|
[here](../../../sound/groups.md#nesting-soundgroups).
|
|
|
|
See [Sound Groups](../../../sound/groups.md) for further details on working
|
|
with the `Class.SoundGroup` class.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: SoundGroup.Volume
|
|
summary: |
|
|
The volume multiplier applied to `Class.Sound|Sounds` that are in the
|
|
`Class.SoundGroup`.
|
|
description: |
|
|
The volume multiplier applied to `Class.Sound|Sounds` which belong to the
|
|
`Class.SoundGroup`. Value can range from `0` to `10`.
|
|
code_samples:
|
|
- Sound-SoundGroup
|
|
type: float
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: State
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- LegacySound
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|