Engine

TremoloSoundEffect

Show Deprecated

The TremoloSoundEffect creates a trembling effect on a sound by varying the volume of the sound up and down.

Like all other SoundEffects, a TremoloSoundEffect can be applied either to a Sound or SoundGroup by being parented to either.

Summary

Properties

  • read parallel

    Controls how much the volume will raise and lower.

  • read parallel

    Controls how long during one volume oscillation the effect will be active.

  • read parallel

    Sets how often the effect will oscillate the volume.

Properties inherited from SoundEffect
  • read parallel

    Toggles the effect on and off.

  • read parallel

    Determines the order the effect will be applied in relation to other effects.

Properties

Depth

read parallel

Range: 0 to 1 (default 1) Controls how much the volume will raise and lower. This value ranges between 0 (minimum volume) and 1 (maximum volume). If set to its minimum, the volume will not oscillate at all.

Duty

read parallel

Range: 0 to 1 (default 0.5) Controls how long during one volume oscillation the effect will be active, specifically what percentage between 0 (0%) and 1 (100%).

Frequency

read parallel

Range: 0.1 to 20 (default 5) Sets how often the effect will oscillate the volume. Measured in Hz.

Methods

Events