SoundCategorySnapshot Script

Extends: Form Script

Script for the manipulation of sound category snapshots. A sound category snapshot is a set of preconfigured volume multipliers for any number of sound categories. They can be used to achieve temporary audio effects such as muting player footstep sounds, lowering the level of ambient sounds, etc. A snapshot's category multipliers can only be fractional (0.0-1.0), so they can't be used to amplify/overdrive a category. The active snapshot is the highest priority snapshot currently pushed to the global snapshot stack (using the priority level on the snapshot form). Snapshots remain on the stack until removed with the Remove member function.

Definition

Scriptname SoundCategorySnapshot extends Form Native Hidden

Properties

None

Global Functions

None

Member Functions

• Function Push(float afTransitionSecs)
  • Push this snapshot to the global category snapshot priority-stack, transitioning over the given time value when becoming active.
• Function Remove()
  • Removes this snapshot from the global category snapshot stack.

Events

None