Difference between revisions of "Sound Script"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (crosslinked) |
||
| Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | |||
[[ | <BR/> | ||
'''Editor:''' [[Sound Descriptor]] | |||
''' | |||
Script for the manipulation of sound base objects. | Script for the manipulation of sound base objects. | ||
| Line 29: | Line 27: | ||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:Audio]] | |||
Latest revision as of 02:04, 2 November 2017
Extends: Form Script
Editor: Sound Descriptor
Script for the manipulation of sound base objects.
Definition[edit | edit source]
ScriptName Sound extends Form Native HiddenProperties[edit | edit source]
None
Global Functions[edit | edit source]
- Function SetInstanceVolume(int aiPlaybackInstance, float afVolume)
- Modify the volume of a playing sound instance. Values outside of 0.0 - 1.0 will be clamped.
- Function StopInstance(int aiPlaybackInstance)
- Cause the given playback instance to cease playback. The next time the sound is played it will have a new instance ID.
Member Functions[edit | edit source]
- int Function 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 Function PlayAndWait(ObjectReference akSource)
- Plays this sound from the source object, and waits for the sound to finish.
Events[edit | edit source]
None