SoundCategory Script

Extends: Form Script
Editor: Sound Category

Script for the manipulation of sound category objects.

DefinitionEdit

ScriptName SoundCategory extends Form Native Hidden

PropertiesEdit

None

Global FunctionsEdit

None

Member FunctionsEdit

  • Function Mute()
    • Render inaudible any sounds in the given sound category.
  • Function Pause()
    • Pause any playing sounds in the given sound category. When restarted any stopped sounds will resume playing from the point at which they were paused.
  • Function SetFrequency(float afFrequencyCoeffecient)
    • Set a frequency modifier [0.0 - 1.0] for any sounds in this category
  • Function SetVolume(float afVolume)
    • Set a volume modifier [0.0 - 1.0] for any sounds in this category
  • Function UnMute()
    • Render audible sounds in the given sound category that were previously Muted.
  • Function UnPause()
    • Play any sounds in the given sound category that are currently paused.

EventsEdit

None