say3D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Add isSpeech's Number description)
Line 29: Line 29:
* an object can only "say" '''one''' sound at a time
* an object can only "say" '''one''' sound at a time
* in order to stop a [[say3D]] sound:
* in order to stop a [[say3D]] sound:
** delete the '''sound source''' with [[deleteVehicle]], or
** delete the returned '''sound source''' with [[deleteVehicle]], or
** kill the '''sound source''' with e.g [[setDamage]].
** kill the '''sound source''' with e.g [[setDamage]].
Prior to {{GVI|arma3|2.00}}, the '''sound source''' object was not returned by the command, so the '''from''' object had to be deleted instead (see Examples [[#Example 2|2]] and [[#Example 3|3]]).
Prior to {{GVI|arma3|2.00}}, the '''sound source''' object was not returned by the command, so the '''from''' object had to be deleted instead (see Examples [[#Example 2|2]] and [[#Example 3|3]]).
Line 54: Line 54:
|p24= pitch: [[Number]] - (Optional, default 1) Pitch of the sound
|p24= pitch: [[Number]] - (Optional, default 1) Pitch of the sound


|p25= isSpeech: [[Boolean]] - (Optional, default [[false]])  
|p25= isSpeech: [[Boolean]] or {{GVI|arma3|2.04|size=0.75}} [[Number]] - (Optional, default [[false]])
* [[true]] = play as speech ([[fadeSpeech]] applies), filters are not applied to it (i.e. house or vehicle interior one)
* 0/[[false]] = play as sound ([[fadeSound]] applies)
* [[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
|p25since= arma3 1.92
|p25since= arma3 1.92


Line 86: Line 87:
|p65= pitch: [[Number]] - (Optional, default 1) Pitch of the sound
|p65= pitch: [[Number]] - (Optional, default 1) Pitch of the sound


|p66= isSpeech: [[Boolean]] - (Optional, default [[false]])  
|p66= isSpeech: [[Boolean]] or {{GVI|arma3|2.04|size=0.75}} [[Number]] - (Optional, default [[false]])
* [[true]] = play as speech ([[fadeSpeech]] applies), filters are not applied to it (i.e. house or vehicle interior one)
* 0/[[false]] = play as sound ([[fadeSound]] applies)
* [[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
|p66since= arma3 2.00
|p66since= arma3 2.00


Line 121: Line 123:
|user= Rocket
|user= Rocket
|timestamp= 20130307131700
|timestamp= 20130307131700
|text= The only difference with this command and [[say]] is during cutscenes (when some camera effect is active). In cutscenes, [[say3D]] is 3D, [[say]] is not.
|text= The only difference with this command and [[say]] is during cutscenes (when some [[Camera Tutorial|camera effect]] is active). In cutscenes, [[say3D]] is 3D, [[say]] is not.
}}
}}


Line 137: Line 139:
|text= This command creates sound object "#soundonvehicle" which can be detected with [[allMissionObjects]]:
|text= This command creates sound object "#soundonvehicle" which can be detected with [[allMissionObjects]]:
<sqf>
<sqf>
onEachFrame {hintSilent str allMissionObjects "#soundonvehicle"};
onEachFrame { hintSilent str allMissionObjects "#soundonvehicle" };
[] spawn { sleep 1; player say3D "Alarm" };
[] spawn { sleep 1; player say3D "Alarm" };
</sqf>
</sqf>
}}
}}

Revision as of 15:40, 23 September 2022

Hover & click on the images for description

Description

Description:
Lets an object say given sound in 3D space. This allows broadcasting of positional music or sound from a source, without having to script a fade sound or music command. Compare this with say2D which will always play a sound at the location of the player after he has been in the vicinity of a broadcasting sound. Sound is defined in "CfgSounds" of the Description.ext or main config.
  • an object can only "say" one sound at a time
  • in order to stop a say3D sound:
Prior to Arma 3 logo black.png2.00, the sound source object was not returned by the command, so the from object had to be deleted instead (see Examples 2 and 3).
Problems:
If the player is in first person view inside a vehicle at the moment of command execution, the sound created is greatly attenuated.
Groups:
Broken CommandsSounds

Syntax 1

Syntax:
from say3D sound
Parameters:
from: Object - origin of the sound
sound: String - classname of the sound to be played. Defined in CfgSounds including Description.ext
Return Value:
Object - the sound source (was Nothing before Arma 3 logo black.png2.00)

Syntax 2

Syntax:
from say3D [sound, maxDistance, pitch, isSpeech, offset]
Parameters:
from: Object - Origin of the sound
sound: String - Classname of the sound to be played. Defined in CfgSounds including Description.ext
maxDistance: Number - (Optional, default 100) Maximum distance in meters at which the sound can be heard
pitch: Number - (Optional, default 1) Pitch of the sound
since Arma 3 logo black.png1.92
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 sound source (was Nothing before Arma 3 logo black.png2.00)

Syntax 3

Syntax:
[from, to] say3D sound
Parameters:
from: Object - Origin of the sound
to: Object - Target
sound: String - Classname of the sound to be played. Defined in CfgSounds including Description.ext
Return Value:
Object - the sound source (was Nothing before Arma 3 logo black.png2.00)

Syntax 4

Syntax:
[from, to] say3D [sound, maxDistance, pitch, isSpeech, offset]
Parameters:
from: Object - Origin of the sound
to: Object - Target
sound: String - Classname of the sound to be played. Defined in CfgSounds including Description.ext
maxDistance: Number - (Optional, default 100) Maximum distance in meters at which the sound can be heard
pitch: Number - (Optional, default 1) Pitch of the sound
since Arma 3 logo black.png2.00
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 sound source (Nothing before Arma 3 logo black.png2.00)

Examples

Example 1:
helicopter1 say3D "FortunateSon";
Example 2:
Workaround for dead bodies:
private _dummy = "#particlesource" createVehicleLocal ASLToAGL getPosWorld _corpse; _dummy say3D "whatever"; _dummy spawn { sleep 5; // at least the length of your sound deleteVehicle _this; };
Example 3:
// Since Arma 3 v2.00, the sound source is returned and can be deleted directly _soundSrc = helicopter1 say3D "Fortunateson"; sleep 5; deleteVehicle _soundSrc; // stop the sound after ~5 seconds

Additional Information

See also:
say say2D playSound 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
Rocket - c
Posted on Mar 07, 2013 - 13:17 (UTC)
The only difference with this command and say is during cutscenes (when some camera effect is active). In cutscenes, say3D is 3D, say is not.
Benargee - c
Posted on Jun 19, 2015 - 21:26 (UTC)
In Arma 2 1.63, the object this command is assigned to must be alive for the sound to broadcast. If the object is killed while the sound is still playing, the sound will stop immediately.
Here is a link to the forum to get around this issue.
I have not tested this in Arma 3 yet.
Killzone_Kid - c
Posted on Mar 11, 2017 - 14:43 (UTC)
This command creates sound object "#soundonvehicle" which can be detected with allMissionObjects:
onEachFrame { hintSilent str allMissionObjects "#soundonvehicle" }; [] spawn { sleep 1; player say3D "Alarm" };