SoundDescriptor Script: Difference between revisions

From the CreationKit Wiki
Jump to navigation Jump to search
m (Convert source tags to syntaxhighlight)
 
Line 14: Line 14:


== Definition ==
== Definition ==
<source lang="papyrus">
<syntaxhighlight lang="papyrus">
ScriptName SoundDescriptor extends Form Hidden
ScriptName SoundDescriptor extends Form Hidden
</source>
</syntaxhighlight>





Latest revision as of 20:22, 5 September 2026

Source: SKSE

Extends: Form Script

Flags: Hidden


Script for the manipulation of Sound Descriptors.


Definition[edit | edit source]

ScriptName SoundDescriptor extends Form Hidden


SKSE Member Functions[edit | edit source]

Float GetDecibelAttenuation()
  • Get the decibel attenuation from the SoundDescriptor.
SetDecibelAttenuation(Float dbAttenuation)
  • Set the decibel attenuation of the SoundDescriptor. A value of 0 is maximum volume, the higher the value the quieter it is. Negative values should not be passed.
Int GetDecibelVariance()
SetDecibelVariance(Int dbVariance)
Int GetFrequencyVariance()
SetFrequencyVariance(Int frequencyVariance)
Int GetFrequencyShift()
  • Get the frequency shift of the SoundDescriptor.
SetFrequencyShift(Int frequencyShift)
  • Set the frequency shift of the SoundDescriptor. Positive values will make the SoundDescriptor higher pitched. Negative values make it lower pitched.