IsSoundPanningEnabled - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:11:36Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:11, 7 November 2024
Line 32:		Line 32:
	addEventHandler("onClientResourceStart", resourceRoot, testPanning)		addEventHandler("onClientResourceStart", resourceRoot, testPanning)
	</syntaxhighlight>		</syntaxhighlight>

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

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

Alvesvin at 00:24, 18 August 2021

2021-08-18T00:24:29Z

← Older revision		Revision as of 00:24, 18 August 2021
Line 41:		Line 41:
	[[hu:isSoundPanningEnabled]]		[[hu:isSoundPanningEnabled]]
	[[ar:isSoundPanningEnabled]]		[[ar:isSoundPanningEnabled]]
			[[pt-br:isSoundPanningEnabled]]

Ahmedrezk at 13:35, 1 July 2020

2020-07-01T13:35:03Z

← Older revision		Revision as of 13:35, 1 July 2020
Line 40:		Line 40:

	[[hu:isSoundPanningEnabled]]		[[hu:isSoundPanningEnabled]]
			[[ar:isSoundPanningEnabled]]

Surge at 15:37, 19 July 2018

2018-07-19T15:37:35Z

← Older revision		Revision as of 15:37, 19 July 2018
Line 4:		Line 4:
	This function checks whether panning is enabled in a [[sound]] [[element]] or not.		This function checks whether panning is enabled in a [[sound]] [[element]] or not.
	}}		}}
	{{Tip\|~~Althrough~~ this function works in no-3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}		{{Tip\|Although this function works in no-3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}

	==Syntax==		==Syntax==

Surge at 15:36, 19 July 2018

2018-07-19T15:36:02Z

← Older revision		Revision as of 15:36, 19 July 2018
Line 39:		Line 39:
	{{Client_audio_functions}}		{{Client_audio_functions}}

	[[hu:~~IsSoundPanningEnabled~~]]		[[hu:isSoundPanningEnabled]]

Surge at 14:28, 19 July 2018

2018-07-19T14:28:30Z

← Older revision		Revision as of 14:28, 19 July 2018
Line 38:		Line 38:
	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

			[[hu:IsSoundPanningEnabled]]

AlexTMjugador at 10:49, 30 December 2014

2014-12-30T10:49:44Z

← Older revision		Revision as of 10:49, 30 December 2014
Line 4:		Line 4:
	This function checks whether panning is enabled in a [[sound]] [[element]] or not.		This function checks whether panning is enabled in a [[sound]] [[element]] or not.
	}}		}}
	{{Tip\|Althrough this function works in no 3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}		{{Tip\|Althrough this function works in no-3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}

	==Syntax==		==Syntax==

AlexTMjugador at 10:49, 30 December 2014

2014-12-30T10:49:00Z

← Older revision		Revision as of 10:49, 30 December 2014
Line 4:		Line 4:
	This function checks whether panning is enabled in a [[sound]] [[element]] or not.		This function checks whether panning is enabled in a [[sound]] [[element]] or not.
	}}		}}
	{{Tip\|Althrough this function works in 2D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}		{{Tip\|Althrough this function works in no 3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}

	==Syntax==		==Syntax==

AlexTMjugador: Added OOP syntax introduced in r6987 and improved the page

2014-12-30T10:33:03Z

Added OOP syntax introduced in r6987 and improved the page

← Older revision		Revision as of 10:33, 30 December 2014
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.0130\|1.3.0\|4162\|		{{New feature/item\|3.0130\|1.3.0\|4162\|
	This function ~~gets the~~ panning ~~state from~~ a [[sound]] [[element]].		This function checks whether panning is enabled in a [[sound]] [[element]] or not.
	}}		}}
			{{Tip\|Althrough this function works in 2D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isSoundPanningEnabled ( element theSound )		bool isSoundPanningEnabled ( element theSound )
	~~</syntaxhighlight>~~

	~~===Example Function===~~
	~~<syntaxhighlight lang="lua">~~
	~~function testCall()~~
	~~local sound = playSound("xy.mp3")~~
	~~local soundPanning = isSoundPanningEnabled(sound)~~
	~~end~~
	</syntaxhighlight>		</syntaxhighlight>
			{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|\|[[sound]]:isPanningEnabled\|panningEnabled\|setSoundPanningEnabled}}}}

	===Required Arguments===		===Required Arguments===
Line 22:		Line 16:

	===Returns===		===Returns===
	Returns ''true'' ~~whether~~ the sound ~~swings~~, ''false'' if it does not.		Returns ''true'' if the sound is valid and it has panning enabled, ''false'' if it does not or is not valid.

			==Example==
			This example plays a ''xy.mp3'' file in the root folder of the resource which contains it at the center of the map, and proves that by default a sound enables panning by outputting the result of this function to the chatbox right after creating it. Then it disables the panning of the sound.

			<syntaxhighlight lang="lua">
			local function testPanning()
			-- Create the sound and output the panning property state
			local sound = playSound3D("xy.mp3", 0, 0, 0)
			outputChatBox("By default, the sound has its panning " .. (isSoundPanningEnabled(sound) and "enabled" or "disabled"))
			-- Disable the panning and ouput a fact
			setSoundPanningEnabled(sound, false)
			outputChatBox("The sound panning was disabled, so it won't annoy you when the camera it's in a side anymore!", 0, 255, 0)
			end
			addEventHandler("onClientResourceStart", resourceRoot, testPanning)
			</syntaxhighlight>

	==Requirements==		==Requirements==

Myonlake at 12:53, 2 January 2014

2014-01-02T12:53:35Z

← Older revision		Revision as of 12:53, 2 January 2014
Line 29:		Line 29:
	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions}}
	~~[[Category:Needs Example]]~~