Scripting - Objects - VolumeGroup, VolumeRule, VolumeModifier

Updated 10 months ago

VolumeGroup

Contains information about how volume should affect certain music.

comment

Text that describes what the volume group does.
Value: A valid string. (e.g. "This is a volume group")
(Optional)

tag

The tag for the group to affect, do not include if you want to affect all music.
Value: A valid string. (e.g. "EscapeMusic")
(Optional)

volumeLerpSpeed

The transition speed between volumes.
Value: A valid float. (e.g. 0.1, 1, 0.125)
Default: 1
(Optional)

stoppingVolumeLerpSpeed

The transition speed for reaching zero when the sound is fading out.
Value: A valid float. (e.g. 0.1, 1, 0.125)
Default: 1
(Optional)

masterVolume

The master volume for all the music in the volume group.
Value: A valid float. (e.g. 0.1, 1, 0.125)
Default: 1
(Optional)

volumeRules

A list of rules that define what volume the group currently has at any given time.
Value: An array of VolumeRules. (Optional)

volumeModifiers

A list of modifiers that define how the volume of the group is modified at any given time.
Value: An array of VolumeModifiers.
(Optional)

VolumeRule

Defines a volume for if a condition passes.

comment

Text that describes what the volume group does.
Value: A valid string. (e.g. "This is a volume rule")
(Optional)

volume

The desired volume.
Value: A valid float. (e.g. 0.1, 1, 0.125)

condition

The condition to check.
Value: A Condition.
(Optional)

VolumeModifier

Defines a volume scale for if a condition passes, this is different to VolumeRule because it scales instead of setting. VolumeModifiers can stack.

comment

Text that describes what the volume group does.
Value: A valid string. (e.g. "This is a volume modifier")
(Optional)

volumeScale

The value to scale the volume by.
Value: A valid float. (e.g. 0.1, 1, 0.125)

condition

The condition to check.
Value: A Condition.
(Optional)