Sound Script: Difference between revisions
Jump to navigation
Jump to search
imported>CraftySentinel (Reverted to List, fixed Link error/spelling) |
imported>SarthesArai m (→SKSE Member Functions: link) |
||
| Line 37: | Line 37: | ||
:'''SoundDescriptor [[GetDescriptor - Sound|GetDescriptor]]()''' | :'''SoundDescriptor [[GetDescriptor - Sound|GetDescriptor]]()''' | ||
:*Returns the | :*Returns the [[Sound Descriptor]] of the Sound. | ||
== Events == | == Events == | ||
None | None | ||
Revision as of 11:29, 20 April 2016
Extends: Form Script (Papyrus)
Script for the manipulation of sound base objects.
Definition
ScriptName Sound extends FormProperties
None
Global Functions
- SetInstanceVolume(Int aiInstanceID, Float afVolume)
- Modify the volume of a playing sound instance. Values outside of 0.0 - 1.0 will be clamped.
- StopInstance(Int aiInstanceID)
- Cause the given playback instance to cease playback. The next time the sound is played it will have a new instance ID.
Member Functions
- Int Play(ObjectReference akSource)
- Plays this sound from the specified source object. The returned integer is the playback instance ID, which can be used to control the sound after it has been started.
- Bool PlayAndWait(ObjectReference akSource)
- Plays this sound from the source object, and waits for the sound to finish.
SKSE Member Functions
- SoundDescriptor GetDescriptor()
- Returns the Sound Descriptor of the Sound.
Events
None