playSound3D - Revision history

BrettMayson at 06:47, 2 January 2026

2026-01-02T06:47:43Z

← Older revision		Revision as of 08:47, 2 January 2026
Line 25:		Line 25:
	\|p3= isInside: [[Boolean]] - (Optional, default [[false]]) - [[true]] to simulate a sound played inside a building or similar		\|p3= isInside: [[Boolean]] - (Optional, default [[false]]) - [[true]] to simulate a sound played inside a building or similar

	\|p4= soundPosition: ~~[[Array]] format~~ [[Position#PositionASL\|PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, overrides ''soundSource''. [[Object]] is also supported (see note below).		\|p4= soundPosition: [[Position#PositionASL\|PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, overrides ''soundSource''. [[Object]] is also supported (see note below).
	{{Feature\|informative\|If a following parameter has to be used, simply use <sqf inline>getPosASL _soundSource</sqf> for ''soundPosition'' instead of <sqf inline>_soundSource</sqf> for ''soundSource''.}}		{{Feature\|informative\|If a following parameter has to be used, simply use <sqf inline>getPosASL _soundSource</sqf> for ''soundPosition'' instead of <sqf inline>_soundSource</sqf> for ''soundSource''.}}
	{{Feature\|important\|This parameter also takes [[Object]] but their [[Position#PositionAGL\|AGL]] position is used instead of [[Position#PositionASL\|ASL]] resulting in sound source being underground if they're above ground, always use [[Position#PositionASL\|PositionASL]] instead.}}		{{Feature\|important\|This parameter also takes [[Object]] but their [[Position#PositionAGL\|AGL]] position is used instead of [[Position#PositionASL\|ASL]] resulting in sound source being underground if they're above ground, always use [[Position#PositionASL\|PositionASL]] instead.}}

NikkoJT at 18:14, 20 December 2025

2025-12-20T18:14:10Z

← Older revision		Revision as of 20:14, 20 December 2025
Line 44:		Line 44:
	\|p9since= arma3 2.06		\|p9since= arma3 2.06

	\|p10= loop: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely. In MP, requires 'local' to be set to [[true]]). Use [[stopSound]] to stop.		\|p10= loop: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely. In MP, requires 'local' to be set to [[true]]. Use [[stopSound]] to stop.
	\|p10since= arma3 2.22		\|p10since= arma3 2.22

NikkoJT: wording

2025-12-20T18:13:56Z

wording

← Older revision		Revision as of 20:13, 20 December 2025
Line 44:		Line 44:
	\|p9since= arma3 2.06		\|p9since= arma3 2.06

	\|p10= loop: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely ~~(SP or~~ MP if 'local' is set to [[true]]). Use [[stopSound]] to stop.		\|p10= loop: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely. In MP, requires 'local' to be set to [[true]]). Use [[stopSound]] to stop.
	\|p10since= arma3 2.22		\|p10since= arma3 2.22

Killzone Kid at 15:37, 16 December 2025

2025-12-16T15:37:24Z

← Older revision		Revision as of 17:37, 16 December 2025
Line 25:		Line 25:
	\|p3= isInside: [[Boolean]] - (Optional, default [[false]]) - [[true]] to simulate a sound played inside a building or similar		\|p3= isInside: [[Boolean]] - (Optional, default [[false]]) - [[true]] to simulate a sound played inside a building or similar

	\|p4= soundPosition: [[Array]] format [[Position#PositionASL\|PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, overrides ''soundSource''. [[Object]] is also supported.		\|p4= soundPosition: [[Array]] format [[Position#PositionASL\|PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, overrides ''soundSource''. [[Object]] is also supported (see note below).
	{{Feature\|informative\|If a following parameter has to be used, simply use <sqf inline>getPosASL _soundSource</sqf> for ''soundPosition'' instead of <sqf inline>_soundSource</sqf> for ''soundSource''.}}		{{Feature\|informative\|If a following parameter has to be used, simply use <sqf inline>getPosASL _soundSource</sqf> for ''soundPosition'' instead of <sqf inline>_soundSource</sqf> for ''soundSource''.}}
	{{Feature\|important\|This parameter also takes [[Object]] but their [[Position#PositionAGL\|AGL]] position is used instead of [[Position#PositionASL\|ASL]] resulting in sound source being underground if they're above ground, always use [[Position#PositionASL\|PositionASL]] instead.}}		{{Feature\|important\|This parameter also takes [[Object]] but their [[Position#PositionAGL\|AGL]] position is used instead of [[Position#PositionASL\|ASL]] resulting in sound source being underground if they're above ground, always use [[Position#PositionASL\|PositionASL]] instead.}}

Killzone Kid at 15:36, 16 December 2025

2025-12-16T15:36:43Z

← Older revision		Revision as of 17:36, 16 December 2025
Line 25:		Line 25:
	\|p3= isInside: [[Boolean]] - (Optional, default [[false]]) - [[true]] to simulate a sound played inside a building or similar		\|p3= isInside: [[Boolean]] - (Optional, default [[false]]) - [[true]] to simulate a sound played inside a building or similar

	\|p4= soundPosition: [[Array]] format [[Position#PositionASL\|PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, overrides ''soundSource''		\|p4= soundPosition: [[Array]] format [[Position#PositionASL\|PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, overrides ''soundSource''. [[Object]] is also supported.
	{{Feature\|informative\|If a following parameter has to be used, simply use <sqf inline>getPosASL _soundSource</sqf> for ''soundPosition'' instead of <sqf inline>_soundSource</sqf> for ''soundSource''.}}		{{Feature\|informative\|If a following parameter has to be used, simply use <sqf inline>getPosASL _soundSource</sqf> for ''soundPosition'' instead of <sqf inline>_soundSource</sqf> for ''soundSource''.}}
	{{Feature\|important\|This parameter also takes [[Object]] but their [[Position#PositionAGL\|AGL]] position is used instead of [[Position#PositionASL\|ASL]] resulting in sound source being underground if they're above ground, always use [[Position#PositionASL\|PositionASL]] instead.}}		{{Feature\|important\|This parameter also takes [[Object]] but their [[Position#PositionAGL\|AGL]] position is used instead of [[Position#PositionASL\|ASL]] resulting in sound source being underground if they're above ground, always use [[Position#PositionASL\|PositionASL]] instead.}}

NikkoJT at 17:17, 21 November 2025

2025-11-21T17:17:54Z

← Older revision		Revision as of 19:17, 21 November 2025
Line 44:		Line 44:
	\|p9since= arma3 2.06		\|p9since= arma3 2.06

	\|p10= ~~local~~: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely (SP or MP if 'local' is set to [[true]]). Use [[stopSound]] to stop.		\|p10= loop: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely (SP or MP if 'local' is set to [[true]]). Use [[stopSound]] to stop.
	\|p10since= arma3 2.22		\|p10since= arma3 2.22

Killzone Kid at 17:07, 21 November 2025

2025-11-21T17:07:38Z

← Older revision		Revision as of 19:07, 21 November 2025
Line 12:		Line 12:
	\|descr= Plays positional sound with given ''filename'' on every computer on network. To stop the sound use [[stopSound]]		\|descr= Plays positional sound with given ''filename'' on every computer on network. To stop the sound use [[stopSound]]

	\|s1= [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local]		\|s1= [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local, loop]

	\|p1= filename: [[String]] - see [[Arma 3: Sound Files]] for available file names or {{Link\|#Example 3}} to use mission files		\|p1= filename: [[String]] - see [[Arma 3: Sound Files]] for available file names or {{Link\|#Example 3}} to use mission files
Line 38:		Line 38:
	\|p7= distance: [[Number]] - (Optional, default 0) how far the sound is audible, in meters. {{hl\|0}} means no maximum distance		\|p7= distance: [[Number]] - (Optional, default 0) how far the sound is audible, in meters. {{hl\|0}} means no maximum distance

	\|p8= offset: [[Number]] - (Optional, default 0) offset in seconds. Same as with [[playMusic]]		\|p8= offset: [[Number]] - (Optional, default 0) offset in seconds. Same as with [[playMusic]] (ignored if sound is set to play repeatedly, see 'loop')
	\|p8since= arma3 2.00		\|p8since= arma3 2.00

	\|p9= local: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will not be broadcast over network		\|p9= local: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will not be broadcast over network
	\|p9since= arma3 2.06		\|p9since= arma3 2.06

			\|p10= local: [[Boolean]] - (Optional, default [[false]]) if [[true]] the sound will repeat indefinitely (SP or MP if 'local' is set to [[true]]). Use [[stopSound]] to stop.
			\|p10since= arma3 2.22

	\|r1= [[Number]] - id of the sound (0..65535) (was [[Nothing]] before {{GVI\|arma3\|2.12\|size= 0.75}})		\|r1= [[Number]] - id of the sound (0..65535) (was [[Nothing]] before {{GVI\|arma3\|2.12\|size= 0.75}})

Killzone Kid at 10:05, 21 November 2025

2025-11-21T10:05:55Z

← Older revision		Revision as of 12:05, 21 November 2025
Line 10:		Line 10:
	\|gr1= Sounds		\|gr1= Sounds

	\|descr= Plays positional sound with given ''filename'' on every computer on network.		\|descr= Plays positional sound with given ''filename'' on every computer on network. To stop the sound use [[stopSound]]

	\|s1= [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local]		\|s1= [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local]
Line 58:		Line 58:
	</sqf>		</sqf>

	\|seealso= [[say3D]] [[playSound]] [[say2D]] [[say]] [[createSoundSource]] [[setRandomLip]] [[getMissionPath]] [[playSoundUI]]		\|seealso= [[say3D]] [[playSound]] [[say2D]] [[say]] [[createSoundSource]] [[setRandomLip]] [[getMissionPath]] [[playSoundUI]] [[stopSound]]
	}}		}}

Lou Montana: Add note about leading antislash, thanks ilbinek

2024-05-28T19:54:20Z

Add note about leading antislash, thanks ilbinek

← Older revision		Revision as of 21:54, 28 May 2024
Line 14:		Line 14:
	\|s1= [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local]		\|s1= [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local]

	\|p1= filename: [[String]] - see [[Arma 3: Sound Files]] for available file names or {{Link\|#Example 3}} to use mission files; {{GVI\|arma3\|2.10\|size= 0.75}} ~~''filename''~~ can start with a leading ~~slash~~ {{hl\|'''\'''a3\...}}		\|p1= filename: [[String]] - see [[Arma 3: Sound Files]] for available file names or {{Link\|#Example 3}} to use mission files

			{{Feature\|important\|
			Since {{GVI\|arma3\|2.10\|size= 0.75}} the file name can start with a leading backslash {{hl\|'''\'''a3\...}}.<br>
			However a leading backslash must '''not''' be used for an '''addon''' sound file.
			}}

	\|p2= soundSource: [[Object]] - the object emitting the sound. If ''soundPosition'' below is specified this parameter is ignored		\|p2= soundSource: [[Object]] - the object emitting the sound. If ''soundPosition'' below is specified this parameter is ignored

Hypoxic125 at 03:36, 25 November 2023

2023-11-25T03:36:19Z

@@ Line 73: / Line 73: @@
 |timestamp= 20201007122400
 |text= The sound will be distorted according to the {{Link|https://en.wikipedia.org/wiki/Doppler_effect}} when passing by the sound source quickly.
 }}