AmbientSoundEffectDeque

Group
player
Extends
Deque
Methods
1
Fields
None

Getting one

client:getAmbientSoundEffects()

Methods

MethodReturnsDescription
clear()()Stop every ambient sound in the list (game thread only): the list is empty after it. The client's own stop does it, the one a scene reload…

Returned by

MethodReturnsDescription
Client.getAmbientSoundEffectsAmbientSoundEffectDequeThe top-level world view's ambient sounds: the looping area sounds its locs and NPCs make. `for _, effect in client:getAmbientSoundEffects(…

Method details

clear

clear: (AmbientSoundEffectDeque) -> ()

Stop every ambient sound in the list (game thread only): the list is empty after it. The client's own stop does it, the one a scene reload makes, so a sound already playing fades out over 150 ms. Nothing happens when the list is empty. Raises on a client whose table does not place the list.