Difference between revisions of "SoundCategory Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Verteiron
(Added notes about sound category persistence and the sound category hierarchy.)
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''Function [[Mute - SoundCategory|Mute]]()'''
*Render inaudible any sounds in the given sound category.


'''Function [[Pause - SoundCategory|Pause]]()'''
{|class="wikitable" width =100%
*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.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[Mute - SoundCategory|'''Mute'''()]]
|Render inaudible any sounds in the given sound category.
|-


'''Function [[SetFrequency - SoundCategory|SetFrequency]](float afFrequencyCoeffecient)'''
|[[Pause - SoundCategory|'''Pause'''()]]
*Set a frequency modifier [0.0 - 1.0] for any sounds in this category
|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 [[SetVolume - SoundCategory|SetVolume]](float afVolume)'''
|[[SetFrequency - SoundCategory|'''SetFrequency'''(Float ''afFrequencyCoeffecient'')]]
*Set a volume modifier [0.0 - 1.0] for any sounds in this category
|Set a frequency modifier [0.0 - 1.0] for any sounds in this category
|-


'''Function [[UnMute - SoundCategory|UnMute]]()'''
|[[SetVolume - SoundCategory|'''SetVolume'''(Float ''afVolume'')]]
*Render audible sounds in the given sound category that were previously Muted.
|Set a volume modifier [0.0 - 1.0] for any sounds in this category
|-


'''Function [[UnPause - SoundCategory|UnPause]]()'''
|[[UnMute - SoundCategory|'''UnMute'''()]]
*Play any sounds in the given sound category that are currently paused.
|Render audible sounds in the given sound category that were previously Muted.
|-
 
|[[UnPause - SoundCategory|'''UnPause'''()]]
|Play any sounds in the given sound category that are currently paused.
|-
 
|}


== Events ==
== Events ==

Revision as of 05:28, 24 October 2013


Extends: Form Script

Script for the manipulation of sound category objects.

Definition

ScriptName SoundCategory extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
Mute() Render inaudible any sounds in the given sound category.
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.
SetFrequency(Float afFrequencyCoeffecient) Set a frequency modifier [0.0 - 1.0] for any sounds in this category
SetVolume(Float afVolume) Set a volume modifier [0.0 - 1.0] for any sounds in this category
UnMute() Render audible sounds in the given sound category that were previously Muted.
UnPause() Play any sounds in the given sound category that are currently paused.

Events

None

Notes

  • A sound category's current volume, mute state or frequency are not stored in savegames. They will be persisted throughout the gaming session. In other words, if you mute a sound category in a script, then load a game that was saved before the mute took place, that sound category will still be muted. Be cautious!
  • Using the Mute, SetFrequency or SetVolume functions will mute the given sound category as well as any sound categories contained within it. Here is the hierarchy of sound categories as defined by the vanilla game:
    • Master
      • MUS
      • PausedDuringMenu
        • VOCGeneral
          • NonVOC
          • VOC
      • PausedDuringMenuLoad
        • SFX
          • UI
          • SFXFadeDuringDialogue
            • PausedDuringMenuFade
              • AMBr
              • MAG
              • MuteSubmerged
            • AMB
            • FST
            • FSTnpc
            • NPCKillMove
Retrieved from "https://ck.uesp.net/w/index.php?title=SoundCategory_Script&oldid=15995"