OnClientWorldSound - Revision history

Motar2k: /* Example */

2020-04-05T21:03:25Z

Example

← Older revision		Revision as of 21:03, 5 April 2020
Line 22:		Line 22:

	==Example==		==Example==
	~~<section name="Client" class="client" show="true">~~		'''Example 1:''' This example will cancel every vehicle sound.
	'''Example 2:''' This example will cancel every vehicle sound.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onClientWorldSound", root, function()		addEventHandler("onClientWorldSound", root, function()
Line 32:		Line 31:
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 1:''' This example lets you see how many times each sound that gets played has been played using '/seesoundlist'.		'''Example 2:''' This example lets you see how many times each sound that gets played has been played using '/seesoundlist'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local sounds = {}		local sounds = {}
Line 57:		Line 56:
	addCommandHandler("seesoundlist", cmdSeeSoundList)		addCommandHandler("seesoundlist", cmdSeeSoundList)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==

Motar2k: /* Example */

2020-04-05T20:49:56Z

Example

← Older revision		Revision as of 20:49, 5 April 2020
Line 22:		Line 22:

	==Example==		==Example==
	This example will cancel every vehicle sound.		<section name="Client" class="client" show="true">
			'''Example 2:''' This example will cancel every vehicle sound.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onClientWorldSound", root, function()		addEventHandler("onClientWorldSound", root, function()
Line 31:		Line 32:
	</syntaxhighlight>		</syntaxhighlight>

	This example lets you see how many times each sound that gets played has been played using '/seesoundlist'.		'''Example 1:''' This example lets you see how many times each sound that gets played has been played using '/seesoundlist'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local sounds = {}		local sounds = {}
Line 56:		Line 57:
	addCommandHandler("seesoundlist", cmdSeeSoundList)		addCommandHandler("seesoundlist", cmdSeeSoundList)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==

Arran Fortuna: Added example to see sound calls

2019-08-23T09:52:46Z

Added example to see sound calls

@@ Line 29: / Line 29: @@
      end
 end)
 </syntaxhighlight>

Arran Fortuna: /* Example */ pretty sure that needs to be root

2019-08-23T09:41:48Z

Example: pretty sure that needs to be root

← Older revision		Revision as of 09:41, 23 August 2019
Line 24:		Line 24:
	This example will cancel every vehicle sound.		This example will cancel every vehicle sound.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onClientWorldSound", ~~resourceRoot~~, function()		addEventHandler("onClientWorldSound", root, function()
	if getElementType(source) == "vehicle" then		if getElementType(source) == "vehicle" then
	cancelEvent()		cancelEvent()

Deihim007: Example added

2019-05-26T07:02:09Z

Example added

← Older revision		Revision as of 07:02, 26 May 2019
Line 21:		Line 21:
	If this event is [[Event system#Canceling\|canceled]], the sound won't play at all.		If this event is [[Event system#Canceling\|canceled]], the sound won't play at all.

	==Example==		==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==		==See Also==

Myonlake at 12:47, 24 May 2019

2019-05-24T12:47:07Z

← Older revision		Revision as of 12:47, 24 May 2019
Line 1:		Line 1:
	{{Client event}}		{{Client event}}
	__NOTOC__		__NOTOC__
	{{New feature/item\|3.0157\|1.5.6\|14652\|		{{New feature/item\|3.0157\|1.5.6\|14652\|This event triggers whenever a GTA sound starts playing.}}
	This event triggers whenever a GTA sound starts playing.
	}}
	{{Note\|Use [[setWorldSoundEnabled]] if you want to disable certain sounds conditionless.		{{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.}}		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.}}
	~~{{Needs_Example}}~~

	==Parameters==		==Parameters==
Line 25:		Line 22:

	==Example==		==Example==
	~~This page does not have an example.~~		{{Example}}
	~~<syntaxhighlight lang="lua">~~
	~~-- Add an example here~~
	~~</syntaxhighlight>~~

	==See Also==		==See Also==

Myonlake at 12:45, 24 May 2019

2019-05-24T12:45:49Z

← Older revision		Revision as of 12:45, 24 May 2019
Line 1:		Line 1:
	{{Client event}}		{{Client event}}
	__NOTOC__		__NOTOC__
	{{New feature/item\|3.0157\|1.5.7\|14652\|		{{New feature/item\|3.0157\|1.5.6\|14652\|
	This event triggers whenever a GTA sound starts playing.		This event triggers whenever a GTA sound starts playing.
	}}		}}

Botder: Move needs-example

2018-09-28T09:17:08Z

Move needs-example

← Older revision		Revision as of 09:17, 28 September 2018
Line 1:		Line 1:
	{{Client event}}		{{Client event}}
	~~{{Needs_Example}}~~
	__NOTOC__		__NOTOC__
	{{New feature/item\|3.0157\|1.5.7\|14652\|		{{New feature/item\|3.0157\|1.5.7\|14652\|
Line 7:		Line 6:
	{{Note\|Use [[setWorldSoundEnabled]] if you want to disable certain sounds conditionless.		{{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.}}		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.}}
			{{Needs_Example}}

	==Parameters==		==Parameters==

Botder at 09:16, 28 September 2018

2018-09-28T09:16:38Z

← Older revision		Revision as of 09:16, 28 September 2018
Line 1:		Line 1:
	#~~REDIRECT~~ [[setWorldSoundEnabled]]		{{Client event}}
			{{Needs_Example}}
			__NOTOC__
			{{New feature/item\|3.0157\|1.5.7\|14652\|
			This event triggers whenever a GTA sound starts playing.
			}}
			{{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.}}

			==Parameters==
			<syntaxhighlight lang="lua">
			int group, int index, float x, float y, float z
			</syntaxhighlight>
			*'''group:''' An [[int\|integer]] representing the [[World sound groups\|world sound group]]
			*'''index:''' An [[int\|integer]] representing an individual sound within the group
			*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
			*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
			*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.

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

			==Cancel effect==
			If this event is [[Event system#Canceling\|canceled]], the sound won't play at all.

			==Example==
			This page does not have an example.
			<syntaxhighlight lang="lua">
			-- Add an example here
			</syntaxhighlight>

			==See Also==
			===World sound functions===
			* [[setWorldSoundEnabled]]
			* [[isWorldSoundEnabled]]
			* [[resetWorldSounds]]
			===Client other events===
			{{Client_other_events}}
			===Client event functions===
			{{Client_event_functions}}

Ccw: Redirected page to SetWorldSoundEnabled

2012-05-19T17:30:18Z

Redirected page to SetWorldSoundEnabled

← Older revision		Revision as of 17:30, 19 May 2012
Line 1:		Line 1:
	~~__NOTOC__~~		#REDIRECT [[setWorldSoundEnabled]]
	~~{{Client event}}~~

	~~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]].~~

	''Note: onClientWorldSound should only be used to stop world sounds from playing. To replace a world sound with a custom sound, it is suggested that you detect when to play the replacement by other means.''

	~~==Parameters==~~
	~~<syntaxhighlight lang="lua">~~
	~~int group, int index~~
	~~</syntaxhighlight>~~

	*'''group''': An integer representing the world sound group
	*'''index''': An integer representing an individual sound within the group

	~~==Source==~~
	~~The [[event system~~#~~Event source\|source]] of this event is the root element~~

	~~==Cancel effect==~~
	~~If this event is~~ [[~~Event system#Canceling\|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~~
	~~<syntaxhighlight lang="lua">~~
	~~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)~~
	~~</syntaxhighlight>~~

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3.0-9.04082\|}}~~

	~~==See Also==~~
	~~===Client sound events===~~
	~~{{Sound_events}}~~