Difference between revisions of "SoundCategory Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Qazaaq
(crosslinked)
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
<BR/>
'''Editor:''' [[Sound Category]]


Script for the manipulation of sound category objects.
Script for the manipulation of sound category objects.
Line 34: Line 32:
== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Audio]]

Latest revision as of 22:51, 1 November 2017

Extends: Form Script
Editor: Sound Category

Script for the manipulation of sound category objects.

Definition[edit | edit source]

ScriptName SoundCategory extends Form Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • 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[edit | edit source]

None