Background for Fallout 4
Member of the Sound script
voidfunctionStopInstance(intaiPlaybackInstance)NativeGlobal

Description

Wiki Description

Stop playback of a sound instance.

Documentation Comment

Stops a given playback instance of a sound


Caveats


Parameters

intaiPlaybackInstance

CK Wiki Description

The instance ID of the sound to stop.


Examples

;This example is from an objectReference script
int instanceID = myLoopingSFX.play(self)    ; play myLoopingSFX sound from my self
Wait(10.0)                                  ; wait while the sound is looping
Sound.StopInstance(instanceID)              ; stop the sound after looping for 10 seconds

Auto-Generated Example

int myInt__aiPlaybackInstance

Sound.StopInstance(myInt__aiPlaybackInstance)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.