0.50

GAGlobalGEGlobal

Hover & click on the images for description

Description

Description:

Plays positional sound with given filename on every computer on network.

Groups:

Sounds

Syntax

Syntax:

playSound3D [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset, local]

Parameters:

filename: String - see Arma 3: Sound Files for available file names or Example 3 to use mission files

⚠

Since 2.10 the file name can start with a leading backslash \a3\....
However a leading backslash must not be used for an addon sound file.

soundSource: Object - the object emitting the sound. If soundPosition below is specified this parameter is ignored

isInside: Boolean - (Optional, default false) - true to simulate a sound played inside a building or similar

soundPosition: Array format PositionASL - (Optional, default [0,0,0]) position for sound emitter, overrides soundSource

ⓘ

If a following parameter has to be used, simply use cgetPosASL _soundSource for soundPosition instead of c_soundSource for soundSource.

⚠

This parameter also takes Object but their AGL position is used instead of ASL resulting in sound source being underground if they're above ground, always use PositionASL instead.

volume: Number - (Optional, default 1) sound volume. A value greater than 5 gets capped

soundPitch: Number - (Optional, default 1)

• 1.0 → normal
• 0.5 → Darth Vader
• 2.0 → Chipmunks

distance: Number - (Optional, default 0) how far the sound is audible, in meters. 0 means no maximum distance

since 2.00

offset: Number - (Optional, default 0) offset in seconds. Same as with playMusic

since 2.06

local: Boolean - (Optional, default false) if true the sound will not be broadcast over network

Return Value:

Number - id of the sound (0..65535) (was Nothing before 2.12)

Examples

Example 1:

Copy

playSound3D ["A3\Sounds_F\sfx\blip1.wss", player];

Example 2:

Copy

playSound3D ["A3\Sounds_F\sfx\blip1.wss", player, false, getPosASL player, 1, 1, 0];

Example 3:

Copy

playSound3D [getMissionPath "mySound.ogg", player]; // to play a mission directory sound

Example 4:

Sound file extension must be specified even if a config entry has none:

Copy

playSound3D ["A3\Sounds_F\sfx\alarm_independent", player]; // no sound playSound3D ["A3\Sounds_F\sfx\alarm_independent.wss", player]; // alarm

Additional Information

See also:

say3D playSound say2D say createSoundSource setRandomLip getMissionPath playSoundUI

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note