playSoundUI - Revision history

Killzone Kid at 17:10, 21 November 2025

2025-11-21T17:10:26Z

← Older revision		Revision as of 19:10, 21 November 2025
Line 10:		Line 10:
	\|descr= Plays given [[CfgSounds]] sound or a [[Arma 3: Sound Files\| sound file]] given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the file path is given, the leading slash will be ignored. To stop the sound use [[stopSound]]		\|descr= Plays given [[CfgSounds]] sound or a [[Arma 3: Sound Files\| sound file]] given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the file path is given, the leading slash will be ignored. To stop the sound use [[stopSound]]

	\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset]		\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset, loop]

	\|p1= sound: [[String]] - [[CfgSounds]] class or file as used in [[playSound3D]] (see [[Arma 3: Sound Files]] for available file names)		\|p1= sound: [[String]] - [[CfgSounds]] class or file as used in [[playSound3D]] (see [[Arma 3: Sound Files]] for available file names)
Line 19:		Line 19:
	* 2.0 → Chipmunks		* 2.0 → Chipmunks
	\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) if [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])		\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) if [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])
	\|p5= offset: [[Number]] - (Optional, default 0) offset in seconds. Same as with [[playSound3D]]		\|p5= offset: [[Number]] - (Optional, default 0) offset in seconds. Same as with [[playSound3D]] (ignored if sound is set to 'loop')
	\|p5since= arma3 2.12		\|p5since= arma3 2.12
			\|p6= loop: [[Boolean]] - (Optional, default [[false]]) If [[true]] the sound will loop forever. Use [[stopSound]] to stop
			\|p6since= arma3 2.22

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

Killzone Kid at 10:06, 21 November 2025

2025-11-21T10:06:20Z

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

	\|descr= Plays given [[CfgSounds]] sound or a [[Arma 3: Sound Files\| sound file]] given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the file path is given, the leading slash will be ignored.		\|descr= Plays given [[CfgSounds]] sound or a [[Arma 3: Sound Files\| sound file]] given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the file path is given, the leading slash will be ignored. To stop the sound use [[stopSound]]

	\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset]		\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset]

Lou Montana: 2.12 mini-update

2023-07-20T13:41:36Z

2.12 mini-update

← Older revision		Revision as of 15:41, 20 July 2023
Line 12:		Line 12:
	\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset]		\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset]

	\|p1= sound: [[String]] - [[CfgSounds]] class or file as used in [[playSound3D]] (~~See~~ [[Arma 3: Sound Files]] for available file names)		\|p1= sound: [[String]] - [[CfgSounds]] class or file as used in [[playSound3D]] (see [[Arma 3: Sound Files]] for available file names)
	\|p2= volume: [[Number]] - (Optional, default 1) ~~Sound~~ volume. ~~A value greater than~~ 5 ~~gets capped~~		\|p2= volume: [[Number]] - (Optional, default 1) sound volume clamped in range 0..5
	\|p3= soundPitch: [[Number]] - (Optional, default 1)		\|p3= soundPitch: [[Number]] - (Optional, default 1)
	* 1.0 → normal		* 1.0 → normal
	* 0.5 → Darth Vader		* 0.5 → Darth Vader
	* 2.0 → Chipmunks		* 2.0 → Chipmunks
	\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) If [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])		\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) if [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])
	\|p5= offset: [[Number]] - (Optional, default 0) ~~Offset~~ in seconds. Same as with [[playSound3D]]		\|p5= offset: [[Number]] - (Optional, default 0) offset in seconds. Same as with [[playSound3D]]
	\|p5since= arma3 2.12		\|p5since= arma3 2.12

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

	\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>		\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>

Lou Montana: 2.12 mini-update

2023-07-20T13:36:42Z

2.12 mini-update

← Older revision		Revision as of 15:36, 20 July 2023
Line 20:		Line 20:
	\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) If [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])		\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) If [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])
	\|p5= offset: [[Number]] - (Optional, default 0) Offset in seconds. Same as with [[playSound3D]]		\|p5= offset: [[Number]] - (Optional, default 0) Offset in seconds. Same as with [[playSound3D]]
	\|p5since= arma3 2.14		\|p5since= arma3 2.12

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

Lou Montana: Some wiki formatting

2023-07-01T14:06:52Z

Some wiki formatting

← Older revision		Revision as of 16:06, 1 July 2023
Line 22:		Line 22:
	\|p5since= arma3 2.14		\|p5since= arma3 2.14

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

	\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>		\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>

Lou Montana: Some wiki formatting

2023-07-01T13:27:48Z

Some wiki formatting

← Older revision		Revision as of 15:27, 1 July 2023
Line 22:		Line 22:
	\|p5since= arma3 2.14		\|p5since= arma3 2.14

	\|r1= ~~[[Nothing]] or~~ [[Number]] - id of the sound (0...65535), since v2.14		\|r1= [[Number]] - id of the sound (0...65535) since {{GVI\|arma3\|2.14}} (was [[Nothing]] before that)

	\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>		\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>
Line 29:		Line 29:

	\|x3= Sound file extension must be specified even if a config entry has none:		\|x3= Sound file extension must be specified even if a config entry has none:
	<sqf>playSoundUI ["A3\Sounds_F\sfx\alarm_independent", 5, 1]; // no sound		<sqf>
	playSoundUI ["A3\Sounds_F\sfx\alarm_independent.wss", 5, 1]; // alarm</sqf>		playSoundUI ["A3\Sounds_F\sfx\alarm_independent", 5, 1]; // no sound
			playSoundUI ["A3\Sounds_F\sfx\alarm_independent.wss", 5, 1]; // alarm
			</sqf>

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

Killzone Kid at 14:20, 24 February 2023

2023-02-24T14:20:39Z

← Older revision		Revision as of 16:20, 24 February 2023
Line 32:		Line 32:
	playSoundUI ["A3\Sounds_F\sfx\alarm_independent.wss", 5, 1]; // alarm</sqf>		playSoundUI ["A3\Sounds_F\sfx\alarm_independent.wss", 5, 1]; // alarm</sqf>

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

Killzone Kid at 14:18, 24 February 2023

2023-02-24T14:18:47Z

← Older revision		Revision as of 16:18, 24 February 2023
Line 22:		Line 22:
	\|p5since= arma3 2.14		\|p5since= arma3 2.14

	\|r1= [[Nothing]] or [[Number]] - id of the sound, since v2.14		\|r1= [[Nothing]] or [[Number]] - id of the sound (0...65535), since v2.14

	\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>		\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>

Killzone Kid at 14:16, 24 February 2023

2023-02-24T14:16:45Z

← Older revision		Revision as of 16:16, 24 February 2023
Line 10:		Line 10:
	\|descr= Plays given [[CfgSounds]] sound or a [[Arma 3: Sound Files\| sound file]] given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the file path is given, the leading slash will be ignored.		\|descr= Plays given [[CfgSounds]] sound or a [[Arma 3: Sound Files\| sound file]] given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the file path is given, the leading slash will be ignored.

	\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect]		\|s1= [[playSoundUI]] [sound, volume, soundPitch, isEffect, offset]

	\|p1= sound: [[String]] - [[CfgSounds]] class or file as used in [[playSound3D]] (See [[Arma 3: Sound Files]] for available file names)		\|p1= sound: [[String]] - [[CfgSounds]] class or file as used in [[playSound3D]] (See [[Arma 3: Sound Files]] for available file names)
Line 19:		Line 19:
	* 2.0 → Chipmunks		* 2.0 → Chipmunks
	\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) If [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])		\|p4= isEffect: [[Boolean]] - (Optional, default [[false]]) If [[true]], diverts sound through effects channel (see [[fadeSound]], [[soundVolume]])
			\|p5= offset: [[Number]] - (Optional, default 0) Offset in seconds. Same as with [[playSound3D]]
			\|p5since= arma3 2.14

	\|r1= [[Nothing]]		\|r1= [[Nothing]] or [[Number]] - id of the sound, since v2.14

	\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>		\|x1= <sqf>playSoundUI ["Alarm", 0.5, 0.5];</sqf>

Lou Montana: Text replacement - "\|branch= *dev " to ""

2022-08-23T12:23:58Z

Text replacement - "\|branch= *dev " to ""

← Older revision		Revision as of 14:23, 23 August 2022
Line 3:		Line 3:
	\|game1= arma3		\|game1= arma3
	\|version1= 2.10		\|version1= 2.10
	~~\|branch= dev~~

	\|eff= local		\|eff= local