PlayAllStoppedSoundsOnce

Definition

PlayAllStoppedSoundsOnce([optional] string exception_1, [optional] string exception_2,..., [optional] string exception_n)

Description

This function plays all stopped ambient, 3D and resource sounds once except for the stopped ambient, 3D and resource sounds sent to the function.

Parameters

[optional] string exception_1, [optional] string exception_2,…, [optional] string exception_n

Specifies the name of the stopped ambient, 3D and resource sounds that should not be played by this function. If no name is passed to PlayAllStoppedSoundsOnce function, all stopped sounds will be played once.

Example

function OnTriggerEnter(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          LoadResource("Sounds", "fire.ogg")
          LoadResource("Sounds", "river.ogg")
          LoadResource("Sounds", "ambient.ogg")
          PlayAllResourceSoundsLoop()
    end
end

function OnTriggerStay(otherActorName)
    --nil means main character controller
    if otherActorName == nil then
          StopAllSounds()
    end
end

function OnTriggerExit(otherActorName)
    if otherActorName == nil then
          PlayAllStoppedSoundsOnce("ambient2", "river_3D2", "Sounds_fire.ogg", "Sounds_river.ogg")
    end
end

Assume that the above script is attached to a trigger named trigger1. Also assume that “ambient2” and “river_3D2” are ambient and 3D sound names, respectively.

Whenever the main character enters “trigger1”, we load and play 3 resource sounds — In order for LoadResource function to load the desired resource, you must first add it through the Add Resource to Current Project dialog (File > Project > Add/Remove Resource to/from Current Project). When the main character stays in the trigger, all the sounds that are playing will be stopped. When the main character exits “trigger1”, all the stopped sounds except the ambient sound “ambient2”, 3D sound “river_3D2” and resource sounds “fire.ogg” and “river.ogg” will be played once.