playSound: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "// since Arma 3" to "// since {{arma3}}")
 
(23 intermediate revisions by the same user not shown)
Line 32: Line 32:
|p1= soundName: [[String]]
|p1= soundName: [[String]]


|r1= [[Object]] - the speaker object ([[Nothing]] before {{arma3}} v2.00)
|r1= [[Object]] - the speaker object ([[Nothing]] before {{GVI|arma3|2.00|size= 0.75}})


|s2= [[playSound]] [soundName, isSpeech, offset]
|s2= [[playSound]] [soundName, isSpeech, offset]
Line 38: Line 38:
|p21= soundName: [[String]]
|p21= soundName: [[String]]


|p22= isSpeech: [[Boolean]] - [[true]] to play it as speech, [[fadeSpeech]] applies. [[false|False]] to play it as sound, [[fadeSound]] applies
|p22= isSpeech: [[Boolean]] or {{GVI|arma3|2.04|size= 0.75}} [[Number]] - (Optional, default [[false]])
* 0/[[false]] = play as sound ([[fadeSound]] applies)
* 1/[[true]] = play as speech ([[fadeSpeech]] applies), filters are not applied to it (i.e. house or vehicle interior one)
* 2 = play as sound ([[fadeSound]] applies) without interior/vehicle muffling


|p23= offset: [[Number]] - (Optional, default 0) Offset in seconds. Same as [[playMusic]]
|p23= offset: [[Number]] - (Optional, default 0) offset in seconds. Same as [[playMusic]]
|p23since= arma3 2.00
|p23since= arma3 2.00


|r2= [[Object]] - the speaker object ([[Nothing]] before {{arma3}} v2.00)
|r2= [[Object]] - the speaker object ([[Nothing]] before {{GVI|arma3|2.00|size= 0.75}})


|x1= <code>[[playSound]] "soundname"</code>
|x1= <sqf>playSound "soundname";</sqf>


|x2= Start a sound and then stop it after 1.2 second:
|x2= Start a sound and then stop it after 1.2 second:
<code>[[playSound]] "AlarmCar";
<sqf>
[] [[spawn]]
playSound "AlarmCar";
0 spawn
{
{
_sound = [[ASLToAGL]] [0,0,0] [[nearestObject]] "#soundonvehicle";
_sound = ASLToAGL [0,0,0] nearestObject "#soundonvehicle";
[[sleep]] 1.2;
sleep 1.2;
[[deleteVehicle]] _sound;
deleteVehicle _sound;
};
};


{{cc|since {{arma3}} v1.99.146480}}
// since {{arma3}} v2.00
_source = [[playSound]] "AlarmCar";
_source = playSound "AlarmCar";
_source [[spawn]]
_source spawn
{
{
[[sleep]] 1.2;
sleep 1.2;
[[deleteVehicle]] _this;
deleteVehicle _this;
};
};
</code>
</sqf>


|x3= Start a sound and wait until it is finished:
|x3= Start a sound and wait until it is finished:
<code>[[playSound]] "Alarm";
<sqf>
[[hint]] "Started!";
playSound "Alarm";
[] [[spawn]]
hint "Started!";
0 spawn
{
{
_sound = [[ASLToAGL]] [0,0,0] [[nearestObject]] "#soundonvehicle";
_sound = ASLToAGL [0,0,0] nearestObject "#soundonvehicle";
[[waitUntil]] {[[isNull]] _sound};
waitUntil {isNull _sound};
[[hint]] "Finished!";
hint "Finished!";
};
};


{{cc|since {{arma3}} v1.99.146480}}
// since {{arma3}} v2.00
_source = [[playSound]] "Alarm";
private _source = playSound "Alarm";
_source [[spawn]]
_source spawn
{
{
[[waitUntil]] {[[isNull]] _this};
waitUntil { isNull _this };
[[hint]] "Finished!";
hint "Finished!";
};
};
</code>
</sqf>


|seealso= [[playSound3D]] [[sideRadio]] [[say]] [[playMusic]] [[say2D]] [[say3D]] [[createSoundSource]] [[playSoundUI]]
|seealso= [[playSound3D]] [[sideRadio]] [[say]] [[playMusic]] [[say2D]] [[say3D]] [[createSoundSource]] [[playSoundUI]]
}}
}}


<dl class="command_description">
{{Note
|user= Hardrock
|timestamp= 20060804105700
|text= ''Notes from before the conversion:''


<dt><dt>
For dialogue involving living units it is better to use [[say]],
<dd class="notedate">Posted on August 4, 2006 - 10:57</dd>
[[playSound]] will play a sound at the location of the player,
<dt class="note">[[User:Hardrock|hardrock]]</dt>
[[say]] will play a sound at the location of the unit that is speaking, and it will only play that sound if the unit is alive.
<dd class="note">''Notes from before the conversion:''
}}


For dialogue involving living units it is better to use [[say]], [[playSound]] will play a sound at the location of the player, [[say]] will play a sound at the location of the unit that is speaking, and it will only play that sound if the unit is alive.
{{Note
<dt></dt>
|user= PiZZADOX
<dd class="notedate">Posted on December 28, 2014 - 08:22 (UTC)</dd>
|timestamp= 20141228082200
<dt class="note">[[User:PiZZADOX|PiZZADOX]]</dt>
|text= As you may have noticed, the parameter for playsound/say3d that deals with the "volume" of the sound played has little to do with the effective loudness heard in game. What it is alters is the drop off for fading the sound at a distance. A higher decibel or integer value will increase the distance before any sort of fading will take place. The actual volume of the sound file played will factor in to this, as it does throughout the playing action.
<dd class="note">
As you may have noticed, the parameter for playsound/say3d that deals with the "volume" of the sound played has little to do with the effective loudness heard in game. What it is alters is the drop off for fading the sound at a distance. A higher decibel or integer value will increase the distance before any sort of fading will take place. The actual volume of the sound file played will factor in to this, as it does throughout the playing action.
==== Amplifying the Sound ====
==== Amplifying the Sound ====
Modifying the effective volume of sounds played by the engine is possible by "spamming" the sounds. By quickly playing the sounds overtop of one another, you can effectively amplify the volume
Modifying the effective volume of sounds played by the engine is possible by "spamming" the sounds. By quickly playing the sounds overtop of one another, you can effectively amplify the volume
<br>
<br>
This example, 
This example
<code>playSound "soundname";
<sqf>
playSound "soundname";
playSound "soundname";
playSound "soundname";
</code>
</sqf>
<br>
Will effectively amplify the sound by a sensed 2x. The volume of the sound file itself will still affect the sound volume as it appears as though the arma engine has no normalization for sound files added to it.
Will effectively amplify the sound by a sensed 2x. The volume of the sound file itself will still affect the sound volume as it appears as though the arma engine has no normalization for sound files added to it.  


==== Notes ====
{{Feature|informative|
 
This technique may cause issues in sound quality in large multiplayer servers. I observed multiple instances when a triggered sound amplified with this method was out of sync with each other. Timing of the individual commands sent over the network is probably the issue. Recommend you compile your amplification code into a single finished function for better syncing for clients not activating the action/far away from the activation position.
This technique may cause issues in sound quality in large multiplayer servers. I observed multiple instances when a triggered sound amplified with this method was out of sync with each other. Timing of the individual commands sent over the network is probably the issue. Recommend you compile your amplification code into a single finished function for better syncing for clients not activating the action/far away from the activation position.  
}}
 
}}
</dd>
 
</dl>

Latest revision as of 18:02, 18 November 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Plays a sound from CfgSounds. Sound can be defined in missionConfigFile, configFile or campaignConfigFile.
Groups:
Sounds

Syntax

Syntax:
playSound soundName
Parameters:
soundName: String
Return Value:
Object - the speaker object (Nothing before Arma 3 logo black.png2.00)

Alternative Syntax

Syntax:
playSound [soundName, isSpeech, offset]
Parameters:
soundName: String
isSpeech: Boolean or Arma 3 logo black.png2.04 Number - (Optional, default false)
  • 0/false = play as sound (fadeSound applies)
  • 1/true = play as speech (fadeSpeech applies), filters are not applied to it (i.e. house or vehicle interior one)
  • 2 = play as sound (fadeSound applies) without interior/vehicle muffling
since Arma 3 logo black.png2.00
offset: Number - (Optional, default 0) offset in seconds. Same as playMusic
Return Value:
Object - the speaker object (Nothing before Arma 3 logo black.png2.00)

Examples

Example 1:
playSound "soundname";
Example 2:
Start a sound and then stop it after 1.2 second:
playSound "AlarmCar"; 0 spawn { _sound = ASLToAGL [0,0,0] nearestObject "#soundonvehicle"; sleep 1.2; deleteVehicle _sound; }; // since Arma 3 v2.00 _source = playSound "AlarmCar"; _source spawn { sleep 1.2; deleteVehicle _this; };
Example 3:
Start a sound and wait until it is finished:
playSound "Alarm"; hint "Started!"; 0 spawn { _sound = ASLToAGL [0,0,0] nearestObject "#soundonvehicle"; waitUntil {isNull _sound}; hint "Finished!"; }; // since Arma 3 v2.00 private _source = playSound "Alarm"; _source spawn { waitUntil { isNull _this }; hint "Finished!"; };

Additional Information

See also:
playSound3D sideRadio say playMusic say2D say3D createSoundSource 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
Hardrock - c
Posted on Aug 04, 2006 - 10:57 (UTC)
Notes from before the conversion: For dialogue involving living units it is better to use say, playSound will play a sound at the location of the player, say will play a sound at the location of the unit that is speaking, and it will only play that sound if the unit is alive.
PiZZADOX - c
Posted on Dec 28, 2014 - 08:22 (UTC)
As you may have noticed, the parameter for playsound/say3d that deals with the "volume" of the sound played has little to do with the effective loudness heard in game. What it is alters is the drop off for fading the sound at a distance. A higher decibel or integer value will increase the distance before any sort of fading will take place. The actual volume of the sound file played will factor in to this, as it does throughout the playing action.

Amplifying the Sound

Modifying the effective volume of sounds played by the engine is possible by "spamming" the sounds. By quickly playing the sounds overtop of one another, you can effectively amplify the volume
This example

playSound "soundname"; playSound "soundname";
Will effectively amplify the sound by a sensed 2x. The volume of the sound file itself will still affect the sound volume as it appears as though the arma engine has no normalization for sound files added to it.

ⓘ
This technique may cause issues in sound quality in large multiplayer servers. I observed multiple instances when a triggered sound amplified with this method was out of sync with each other. Timing of the individual commands sent over the network is probably the issue. Recommend you compile your amplification code into a single finished function for better syncing for clients not activating the action/far away from the activation position.
Retrieved from "https://community.bistudio.com/wiki?title=playSound&oldid=349659"