SoundCategory Script

This article is part of the CK Wiki archive project.

Extends: Form Script
Editor: Resource:Creation Kit/Sound Category

Script for the manipulation of sound category objects.

Definition

ScriptName SoundCategory extends Form Native Hidden

Properties

None

Global Functions

None

Member Functions

• 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.

Events

None