Sound Script: Difference between revisions

Jump to navigation Jump to search
228 bytes added ,  24 October 2013
m
Formatting Change
imported>Jog
imported>CraftySentinel
m (Formatting Change)
Line 16: Line 16:


== Global Functions ==
== Global Functions ==
'''Function [[SetInstanceVolume - Sound|SetInstanceVolume]](int aiInstanceID, float afVolume)'''
*Modify the volume of a playing sound instance. Values outside of 0.0 - 1.0 will be clamped.


'''Function [[StopInstance- Sound|StopInstance]](int aiInstanceID)'''
{|class="wikitable" width =100%
*Cause the given playback instance to cease playback. The next time the sound is played it will have a new instance ID.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[SetInstanceVolume - Sound|'''SetInstanceVolume'''(Int ''aiInstanceID'', Float ''afVolume'')]]
|Modify the volume of a playing sound instance. Values outside of 0.0 - 1.0 will be clamped.
|-
 
|[[StopInstance- Sound|'''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 ==
== Member Functions ==
'''int Function [[Play - Sound|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.
{|class="wikitable" width =100%
'''bool Function [[PlayAndWait - Sound|PlayAndWait]](ObjectReference akSource)'''
!style="text-align:left;"|Function
*Plays this sound from the source object, and waits for the sound to finish.
!style="text-align:left;"|Description
|-
|[[Play - Sound|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.
|-
 
|[[PlayAndWait - Sound|Bool '''PlayAndWait'''(ObjectReference ''akSource'')]]
|Plays this sound from the source object, and waits for the sound to finish.
|-
 
|}


== Events ==
== Events ==
None
None

Navigation menu