OnClientWorldSound
Jump to navigation
Jump to search
This event is triggered whenever a world sound is played. A world sound is a sound effect which has not been caused by playSound or playSound3D.
Parameters
int group, int index
- group: An integer representing the world sound group
- index: An integer representing an individual sound within the group
Source
The source of this event is the root element
Cancel effect
If this event is canceled, then the sound will not be played.
Example
This example prints the world sound group and index in the chat box, and stops all world sound effects in group 5
function handleOnClientWorldSound( group, index ) outputChatBox( "World sound group:" .. group .. ", index:" .. index ) if group == 5 then cancelEvent() -- Don't play this end end addEventHandler ( "onClientWorldSound", getRootElement(), handleOnClientWorldSound)
Requirements
Minimum server version | n/a |
---|---|
Minimum client version | 1.3.0-9.04082 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04082" />
See Also
Client sound events
- onClientSoundBeat
- onClientSoundChangedMeta
- onClientSoundFinishedDownload
- onClientSoundStarted
- onClientSoundStopped
- onClientSoundStream