OnClientWorldSound: Difference between revisions

Revision as of 07:02, 26 May 2019

This event triggers whenever a GTA sound starts playing.

[[{{{image}}}\|link=\|]]	Note: Use setWorldSoundEnabled if you want to disable certain sounds conditionless. For example, you should only cancel player emitted sounds in this event, because when you cancel certain vehicle sounds, the game will try to play the same sound on the next frame.

int group, int index, float x, float y, float z

The source of this event is the element, which emitted the sound.

If this event is canceled, the sound won't play at all.

This example will cancel every vehicle sound.

addEventHandler("onClientWorldSound", resourceRoot, function()
    if getElementType(source) == "vehicle" then
        cancelEvent()
    end
end)

@@ Line 21: / Line 21: @@
 If this event is [[Event system#Canceling|canceled]], the sound won't play at all.
 ==Example==
-{{Example}}
+This example will cancel every vehicle sound.
+<syntaxhighlight lang="lua">
+addEventHandler("onClientWorldSound", resourceRoot, function()
+    if getElementType(source) == "vehicle" then
+        cancelEvent()
+    end
+end)
+</syntaxhighlight>
 ==See Also==