SetSoundPanningEnabled - Revision history

Lvrent at 21:15, 23 September 2021

2021-09-23T21:15:15Z

← Older revision		Revision as of 21:15, 23 September 2021
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>
	{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|The method name was incorrect (setPann'''n'''ingEnabled) before version '''1.5.8~~-9.20761.0~~'''.\|[[sound]]:setPanningEnabled\|panningEnabled\|isSoundPanningEnabled}}}}		{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|The method name was incorrect (setPann'''n'''ingEnabled) before version '''1.5.8 r20761'''.\|[[sound]]:setPanningEnabled\|panningEnabled\|isSoundPanningEnabled}}}}

	===Required arguments===		===Required arguments===

StrixG: note that method name was incorrect

2020-12-17T11:09:45Z

note that method name was incorrect

← Older revision		Revision as of 11:09, 17 December 2020
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function toggles the panning of a sound (hearing it closer to the left or right side of the speakers due to the camera position). By default a sound has its panning enabled.		This function toggles the panning of a sound (hearing it closer to the left or right side of the speakers due to the camera position). By default a sound has its panning enabled.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>
	{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|\|[[sound]]:setPanningEnabled\|panningEnabled\|isSoundPanningEnabled}}}}		{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|The method name was incorrect (setPann'''n'''ingEnabled) before version '''1.5.8-9.20761.0'''.\|[[sound]]:setPanningEnabled\|panningEnabled\|isSoundPanningEnabled}}}}

	===Required arguments===		===Required arguments===

Surge at 09:57, 22 July 2018

2018-07-22T09:57:50Z

← Older revision		Revision as of 09:57, 22 July 2018
Line 35:		Line 35:
	==See also==		==See also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

			[[hu:setSoundPanningEnabled]]

AlexTMjugador: /* Returns */

2014-12-30T10:48:06Z

Returns

← Older revision		Revision as of 10:48, 30 December 2014
Line 14:		Line 14:
	Returns ''true'' if the sound is valid and good arguments were passed, ''false'' if not.		Returns ''true'' if the sound is valid and good arguments were passed, ''false'' if not.

	If the sound is 2D, this function will return ''true'' as well, but [[isSoundPanningEnabled]] will always return ''true'' after this (so it has no effect).		If the sound is not 3D, this function will return ''true'' as well, but [[isSoundPanningEnabled]] will always return ''true'' after this (so it has no effect).

	==Example==		==Example==

AlexTMjugador: Added OOP syntax introduced in r6987 and fixed a incorrect fact (this function actually returns true in 2D sounds, but it has no effect)

2014-12-30T10:06:33Z

Added OOP syntax introduced in r6987 and fixed a incorrect fact (this function actually returns true in 2D sounds, but it has no effect)

← Older revision		Revision as of 10:06, 30 December 2014
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>
			{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|\|[[sound]]:setPanningEnabled\|panningEnabled\|isSoundPanningEnabled}}}}

	===Required arguments===		===Required arguments===
Line 11:		Line 12:

	===Returns===		===Returns===
	Returns ''true'' if the sound is valid~~, is 3D~~ and good arguments were passed, ''false'' if not.		Returns ''true'' if the sound is valid and good arguments were passed, ''false'' if not.

			If the sound is 2D, this function will return ''true'' as well, but [[isSoundPanningEnabled]] will always return ''true'' after this (so it has no effect).

	==Example==		==Example==

AlexTMjugador: /* Example */

2014-05-25T10:26:12Z

Example

← Older revision		Revision as of 10:26, 25 May 2014
Line 16:		Line 16:
	This example creates a sound at the center of the map when the resource which cointains it starts and adds a command called /soundpanning, which changes the panning of the sound.		This example creates a sound at the center of the map when the resource which cointains it starts and adds a command called /soundpanning, which changes the panning of the sound.

	<syntaxhighlight lang="lua">local panned		<syntaxhighlight lang="lua">local panned = true
	local sound = playSFX3D("script", 7, 1, 0, 0, 20, true)		local sound = playSFX3D("script", 7, 1, 0, 0, 20, true)

Line 29:		Line 29:
	end		end
	addCommandHandler("soundpanning", changePanning)</syntaxhighlight>		addCommandHandler("soundpanning", changePanning)</syntaxhighlight>

	==See also==		==See also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

AlexTMjugador: Added "see also"

2014-05-25T10:03:45Z

Added "see also"

← Older revision		Revision as of 10:03, 25 May 2014
Line 29:		Line 29:
	end		end
	addCommandHandler("soundpanning", changePanning)</syntaxhighlight>		addCommandHandler("soundpanning", changePanning)</syntaxhighlight>
			==See also==
			{{Client_audio_functions}}

AlexTMjugador: Created page, but needs documentation and testing

2014-05-25T09:44:22Z

Created page, but needs documentation and testing

New page

__NOTOC__
{{Client function}}
This function toggles the panning of a sound (hearing it closer to the left or right side of the speakers due to the camera position). By default a sound has its panning enabled.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPanningEnabled ( element sound, bool enable )</syntaxhighlight>

===Required arguments===
*'''sound:''' a [[sound]] element to change the panning of.
*'''enable:''' ''true'' to enable the panning, ''false'' otherwise.

===Returns===
Returns ''true'' if the sound is valid, is 3D and good arguments were passed, ''false'' if not.

==Example==
This example creates a sound at the center of the map when the resource which cointains it starts and adds a command called /soundpanning, which changes the panning of the sound.

<syntaxhighlight lang="lua">local panned
local sound = playSFX3D("script", 7, 1, 0, 0, 20, true)

function changePanning()
if sound then
setSoundPanningEnabled(sound, not panned)
panned = not panned
outputChatBox("Sound panning changed to " .. tostring(panned))
else
outputDebugString("Looks that your GTA was ripped.")
end
end
addCommandHandler("soundpanning", changePanning)</syntaxhighlight>