Difference between revisions of "SoundCategorySnapshot Script"

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


Script for the manipulation of sound category snapshots. A sound category snapshot is a set of preconfigured volume multipliers for any number of sound categories. They can be used to achieve temporary audio effects such as muting player footstep sounds, lowering the level of ambient sounds, etc.  A snapshot's category multipliers can only be fractional (0.0-1.0), so they can't be used to amplify/overdrive a category. The active snapshot is the highest priority snapshot currently pushed to the global snapshot stack (using the priority level on the snapshot form). Snapshots remain on the stack until removed with the Remove member function.
Script for the manipulation of sound category snapshots. A sound category snapshot is a set of preconfigured volume multipliers for any number of sound categories.  


== Definition ==
== Definition ==
Line 26: Line 24:
== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Audio]]

Latest revision as of 00:05, 2 November 2017

Extends: Form Script
Editor: Category Snapshot

Script for the manipulation of sound category snapshots. A sound category snapshot is a set of preconfigured volume multipliers for any number of sound categories.

Definition[edit | edit source]

Scriptname SoundCategorySnapshot extends Form Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • Function Push(float afTransitionSecs)
    • Push this snapshot to the global category snapshot priority-stack, transitioning over the given time value when becoming active.
  • Function Remove()
    • Removes this snapshot from the global category snapshot stack.

Events[edit | edit source]

None