createSoundSource: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
(added seeAlso)
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= ofpe
|1.00
|version1= 1.00
 
|game2= arma1
|version2= 1.00
 
|game3= arma2
|version3= 1.00
 
|game4= arma2oa
|version4= 1.50
 
|game5= tkoh
|version5= 1.00
 
|game6= arma3
|version6= 0.50


|arg= global
|arg= global
Line 8: Line 23:
|eff= global
|eff= global


|gr1= Broken Commands
|gr1= Sounds
|gr2= Sounds
 
|descr= Creates a sound source of the given type (type is the name of the subclass of [[ArmA:_CfgVehicles|CfgVehicles]] which is pointing to the sound defined in [[CfgSFX]]).
The actual sound object created is of type {{hl|"#dynamicsound"}} and could be detected with [[allMissionObjects]].
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 {{arma3}}:
{{Columns|4|
* {{hl|"Sound_Alarm"}}
* {{hl|"Sound_Alarm2"}}
* {{hl|"Sound_BattlefieldExplosions"}}
* {{hl|"Sound_BattlefieldFirefight"}}
* {{hl|"Sound_Fire"}}
* {{hl|"Sound_SmokeWreck1"}}
* {{hl|"Sound_SparklesWreck1"}}
* {{hl|"Sound_SparklesWreck2"}}
* {{hl|"Sound_Stream"}}
}}
 
Since {{GVI|arma3|1.70}} it is possible to define sounds for use with [[createSoundSource]] in [[Description.ext]].
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|description.ext]] - see {{Link|#Example 3}}.<br>
 
{{Feature|informative|A sound created by [[createSoundSource]] will always be looping.}}
 
{{Feature|arma3|In earlier {{arma3}} versions, the sound created was greatly attenuated if the player was in first person view inside a vehicle at the moment of execution.}}
 
|mp= When a [[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.
 
|s1= [[createSoundSource]] [type, position, markers, placement]
 
|p1= type: [[String]] - [[CfgVehicles]] class
 
|p2= position: [[Object]] or [[Array]] format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] - desired placement position
 
|p3= 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 a Z coordinate with [[setMarkerPos]], the sound will also be created at the given Z coordinate
 
|p4= placement: [[Number]] - the sound is placed inside a circle with given position as center and placement as its radius
 
|r1= [[Object]]
 
|x1= <sqf>_soundSource = createSoundSource ["LittleDog", position player, [], 0];</sqf>


| Creates a sound source of the given type (type is the name of the subclass of [[ArmA:_CfgVehicles|CfgVehicles]] which is pointing to the sound defined in [[CfgSFX]]). The actual sound object created is of type <tt>"#dynamicsound"</tt> and could be detected with [[allMissionObjects]]. 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:
|x2= <sqf>
* <tt>"Sound_Alarm"</tt>
0 spawn
* <tt>"Sound_Alarm2"</tt>
{
* <tt>"Sound_BattlefieldExplosions"</tt>
_alarm = createSoundSource ["Sound_Alarm", position player, [], 0]; // starts alarm
* <tt>"Sound_BattlefieldFirefight"</tt>
sleep 10;
* <tt>"Sound_Fire"</tt>
deleteVehicle _alarm; // stops alarm
* <tt>"Sound_SmokeWreck1"</tt>
};
* <tt>"Sound_SparklesWreck1"</tt>
</sqf>
* <tt>"Sound_SparklesWreck2"</tt>
* <tt>"Sound_Stream"</tt>
Since Arma 3 v1.70 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:


<syntaxhighlight lang=php>
|x3= {{GVI|arma3|1.70}} Here is an example of suitable mission config definition:
<syntaxhighlight lang="cpp">
// description.ext
// description.ext
class CfgSFX
class CfgSFX
{
{
class MyOwl
class MyOwl
{
{
sound0[] = {"@A3\Sounds_F\environment\animals\birds\owl1", db-10, 1.0, 1000, 0.2, 0, 15, 30}; // path to addon sound
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
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
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};
sounds[] = { "sound0", "sound1", "sound2" };
empty[] = {"", 0, 0, 0, 0, 0, 0, 0};
empty[] = { "", 0, 0, 0, 0, 0, 0, 0 };
};
};
};
};
Line 47: Line 99:
</syntaxhighlight>
</syntaxhighlight>


<code>_owl <nowiki>=</nowiki> [[createSoundSource]] ["MyOwlSound", [[position]] [[player]], [], 0];</code>
<sqf>private _owl = createSoundSource ["MyOwlSound", position player, [], 0];</sqf>
 
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.


{{Feature|important| For some unknown reason if at the moment of command execution the player is in first person view and is inside a vehicle, the sound created is greatly attenuated}}
|seealso= [[createSoundSourceLocal]] [[playSound]] [[playSound3D]] [[sideRadio]] [[say]] [[say2D]] [[say3D]] [[playMusic]] [[playSoundUI]]
 
|'''createSoundSource''' [type, position, markers, placement]
 
|p1= [type, position, markers, placement]: [[Array]]
|p2= type: [[String]] - [[CfgVehicles]] class
|p3= position:  [[PositionAGL]], [[Position2D]] or [[Object]] - Desired placement position
|p4= 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
|p5= placement: [[Number]] - The sound is placed inside a circle with given position as center and placement as its radius
| [[Object]]
 
|x1= <code>_soundSource = [[createSoundSource]] ["LittleDog", [[position]] [[player]], [], 0]</code>
|x2= <code>[] spawn
{
_alarm = [[createSoundSource]] ["Sound_Alarm", [[position]] [[player]], [], 0]; //starts alarm
[[sleep]] 10;
[[deleteVehicle]] _alarm; //stops alarm
};</code>
 
|seealso= [[playSound]], [[playSound3D]], [[sideRadio]], [[say]], [[say2D]], [[say3D]], [[playMusic]]
}}
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 07:53, 12 October 2024

Hover & click on the images for description

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). The actual sound object created is of type "#dynamicsound" and could be detected with allMissionObjects. 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 logo black.png1.70 it is possible to define sounds for use with createSoundSource in Description.ext. 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 - see Example 3.

A sound created by createSoundSource will always be looping.
Arma 3
In earlier Arma 3 versions, the sound created was greatly attenuated if the player was in first person view inside a vehicle at the moment of execution.
Multiplayer:
When a 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.
Groups:
Sounds

Syntax

Syntax:
createSoundSource [type, position, markers, placement]
Parameters:
type: String - CfgVehicles class
position: Object or Array format PositionAGL or Position2D - 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 a Z coordinate with setMarkerPos, the sound will also be created at the 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:
0 spawn { _alarm = createSoundSource ["Sound_Alarm", position player, [], 0]; // starts alarm sleep 10; deleteVehicle _alarm; // stops alarm };
Example 3:
Arma 3 logo black.png1.70 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
	};
};
private _owl = createSoundSource ["MyOwlSound", position player, [], 0];

Additional Information

See also:
createSoundSourceLocal playSound playSound3D sideRadio say say2D say3D playMusic 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