playSound: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "{{since" to "{{Since")
Line 18: Line 18:
|p1= soundName: [[String]] |PARAMETER1=
|p1= soundName: [[String]] |PARAMETER1=


| [[Nothing]], {{since|arma3|1.99.146480}} [[Object]] |RETURNVALUE=
| [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]] |RETURNVALUE=


____________________________________________________________________________________________
____________________________________________________________________________________________
Line 25: Line 25:
|p22= soundName: [[String]] |PARAMETER22=
|p22= soundName: [[String]] |PARAMETER22=
|p23= isSpeech: [[Boolean]] - play as speech through radio channel, [[fadeSpeech]] applies. |PARAMETER23=
|p23= isSpeech: [[Boolean]] - play as speech through radio channel, [[fadeSpeech]] applies. |PARAMETER23=
|p24= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{since|arma3|1.99.146480|true}} |PARAMETER24=
|p24= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}} |PARAMETER24=


|r2= [[Nothing]], {{since|arma3|1.99.146480}} [[Object]] |RETURNVALUE2=
|r2= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]] |RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
Line 40: Line 40:
};
};


{{cc|{{since|arma3|1.99.146480}}}}
{{cc|{{Since|arma3|1.99.146480}}}}
_source = [[playSound]] "AlarmCar";
_source = [[playSound]] "AlarmCar";
_source [[spawn]]  
_source [[spawn]]  
Line 58: Line 58:
};
};


{{cc|{{since|arma3|1.99.146480}}}}
{{cc|{{Since|arma3|1.99.146480}}}}
_source = [[playSound]] "Alarm";
_source = [[playSound]] "Alarm";
_source [[spawn]]  
_source [[spawn]]  

Revision as of 19:39, 11 January 2021

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:
Nothing, Template:Since Object

Alternative Syntax

Syntax:
playSound [soundName, isSpeech, offset]
Parameters:
[soundName, isSpeech]: Array
soundName: String
isSpeech: Boolean - play as speech through radio channel, fadeSpeech applies.
offset: Scalar - (Optional) Offset in seconds. Same with playMusic. Default: 0 Template:Since
Return Value:
Nothing, Template:Since Object

Examples

Example 1:
playSound "soundname"
Example 2:
Start a sound and then stop it after 1.2 second:playSound "AlarmCar"; [] spawn { _sound = ASLToAGL [0,0,0] nearestObject "#soundonvehicle"; sleep 1.2; deleteVehicle _sound; }; // Template:Since _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!"; [] spawn { _sound = ASLToAGL [0,0,0] nearestObject "#soundonvehicle"; waitUntil {isNull _sound}; hint "Finished!"; }; // Template:Since _source = playSound "Alarm"; _source spawn { waitUntil {isNull _this}; hint "Finished!"; };

Additional Information

See also:
playSound3DsideRadiosayplayMusicsay2Dsay3DcreateSoundSource

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

Notes

Posted on August 4, 2006 - 10:57
hardrock
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.

Bottom Section

Posted on December 28, 2014 - 08:22 (UTC)
PiZZADOX
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.

Notes

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.