createSoundSource

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Armed Assault version 1.00
  Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are broadcasted over the network and happen on every computer in the network

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.00

Description

Description:
Creates a sound source of the given type (type is the name of the subclass of CfgVehicles which is pointing to the sound defined in CfgSFX). If the markers array contains several marker names, the position of a random one is used, otherwise, the given position is used. The sound source is placed inside a circle with this position as its center and placement as its radius. Some of the vanilla classes pre-configured in Arma 3:
  • "Sound_Alarm"
  • "Sound_Alarm2"
  • "Sound_BattlefieldExplosions"
  • "Sound_BattlefieldFirefight"
  • "Sound_Fire"
  • "Sound_SmokeWreck1"
  • "Sound_SparklesWreck1"
  • "Sound_SparklesWreck2"
  • "Sound_Stream"
Since Arma 3 v1.69.141183 it is possible to define sounds for use with createSoundSource in mission config. As mentioned earlier, the sounds needed for this command should be defined inside CfgVehicles class, which itself references CfgSFX class. If given class searched in main config and is not found, the search will continue in description.ext. Here is an example of suitable mission config definition:
// description.ext

class CfgSFX
{
	class MyOwl
	{
		sound0[] = {"@A3\Sounds_F\environment\animals\birds\owl1", db-10, 1.0, 1000, 0.2, 0, 15, 30};  // path to addon sound
		sound1[] = {"@A3\Sounds_F\environment\animals\birds\owl2", db-10, 1.0, 1000, 0.2, 0, 15, 30};  // path to addon sound
		sound2[] = {"@A3\Sounds_F\environment\animals\birds\owl3", db-10, 1.0, 1000, 0.2, 0, 15, 30};  // path to addon sound
		sounds[] = {sound0, sound1, sound2};
		empty[] = {"", 0, 0, 0, 0, 0, 0, 0};
	};
};

class CfgVehicles
{
	class MyOwlSound // class name to be used with createSoundSource
	{
		sound = "MyOwl"; // reference to CfgSFX class
	};
};

_owl = createSoundSource ["MyOwlSound", position player, [], 0];

Note that the sound created by createSoundSource will always be looping. Also when CfgSFX sound definition contains more than 1 sound, there is no guarantee that the sound played will be the same on every PC in Multiplayer.

Syntax

Syntax:
createSoundSource [type, position, markers, placement]
Parameters:
[type, position, markers, placement]: Array
type: String - CfgVehicles class
position: PositionAGL, Position2D or Object - Desired placement position
markers: Array - If the markers array contains any markers, the position is randomly picked from array of given markers plus desired placement position. If any of the markers were given z coordinate with setMarkerPos, the sound will also be created at given z coordinate
placement: Number - The sound is placed inside a circle with given position as center and placement as its radius
Return Value:
Object

Examples

Example 1:
_soundSource = createSoundSource ["LittleDog", position player, [], 0]
Example 2:
[] spawn { _alarm = createSoundSource ["Sound_Alarm", position player, [], 0]; //starts alarm sleep 10; deleteVehicle _alarm; //stops alarm };

Additional Information

Multiplayer:
-
See also:
playSoundplaySound3DsideRadiosaysay2Dsay3DplayMusic

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section