Modifiers

Reference of all the modifiers available in the SoundEvent, SoundTrigger etc

Modifiers are used to control how SoundEvents are played (e.g. volume, polyphony, fade in length etc). They are available on the SoundEvent, SoundTrigger, SoundPicker and SoundMix objects. They have similar functionality as the SoundParameters, but with visual editing. Modifiers are only updated once when starting the SoundEvent, not continuously.

Some modifiers use priorities to determine what a final modifier value should be. The modifier with the highest priority will determine the value.

Volume dB Volume offset in decibel. Note that modifiers are only updated once when starting the SoundEvent. If you want realtime volume settings for a loop, use the SoundEvent base, timeline or SoundContainer volume.

Pitch st Pitch offset in semitones.

Delay Increase the delay in seconds.

Start Position Sets the start position, 0 is the start, 1 is the end. The highest priority added modifier will determine the value.

Reverse If enabled the AudioClip will be played backwards. Make sure to set the start position to the end. Reverse is only supported for AudioClips which are stored in an uncompressed format or will be decompressed at load time. The highest priority added modifier will determine the value.

Distance Scale Distance scale multiplier (how far it will be heard). It is multiplied by the Distance Scale of the SoundManager.

Reverb Zone Mix dB Reverb Zone Mix volume offset in decibel.

Fade In Length The length of the fade in. Is calculated using the time scale selected in the SoundManager. The highest priority added modifier will determine the value.

Fade In Shape Shape of the fade in Negative is exponential, 0 is linear, positive is logarithmic. The highest priority added modifier will determine the value.

Fade Out Length The length of the fade out. Is calculated using the time scale selected in the SoundManager. The highest priority added modifier will determine the value.

Fade Out Shape Shape of the fade out Negative is exponential, 0 is linear, positive is logarithmic. The highest priority added modifier will determine the value.

Increase 2D Makes the SoundEvent more 2D (less spatialized). Useful for first person sounds.

Stereo Pan Stereo pan offset -1 is left, 0 is centered, +1 is right.

Intensity

Multiplier of any used SoundParameterIntensity parameter.

Distortion Increase Increases the distortion. Distortion needs to be enabled on the SoundContainer for this to have any effect.

Polyphony How many instances of the SoundEvent that can exist at the same transform. Modifier polyphony overrides the SoundEvents base Polyphony value. The highest priority added modifier will determine the value.

Follow Position If the SoundEvent should follow the given Transform position. The highest priority added modifier will determine the value.

Bypass Reverb Zones If enabled all reverb zones will be bypassed. The highest priority added modifier will determine the value.

Bypass Voice Effects If enabled all voice effects (lowpass/highpass/distortion) will be bypassed. The highest priority added modifier will determine the value.

Bypass Listener Effects If enabled all listener effects will be bypassed. The highest priority added modifier will determine the value.

Last updated