StopInstance - Sound

Member of: Sound Script

Stop playback of a sound instance.

Syntax

Function StopInstance(int aiPlaybackInstance) native global

Parameters

• aiPlaybackInstance: The instance ID of the sound to stop.

Return Value

None.

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

See Also

• Sound Script
• Play - Sound