say3D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
Line 26: Line 26:
Sound is defined in [[Description.ext#CfgSounds|"CfgSounds"]] of the [[Description.ext]] or main config.
Sound is defined in [[Description.ext#CfgSounds|"CfgSounds"]] of the [[Description.ext]] or main config.


{{Feature | Informative | An object can only "say" '''one''' sound at a time.}}
{{Feature|informative|
 
* an object can only "say" '''one''' sound at a time
{{Feature | Informative | In order to stop a [[say3D]] sound:
* in order to stop a [[say3D]] sound:
* delete the '''sound source''' with [[deleteVehicle]], or
** delete the '''sound source''' with [[deleteVehicle]], or
* kill the '''sound source''' with e.g [[setDamage]].
** kill the '''sound source''' with e.g [[setDamage]].
Prior to {{arma3}} v2.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).
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]]).
}}
}}


|pr= 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.
|pr= If the player is in first person view inside a vehicle at the moment of command execution, the sound created is greatly attenuated.


|s1= from [[say3D]] sound
|s1= from [[say3D]] sound


|p1= from: [[Object]] - Origin of the sound
|p1= from: [[Object]] - origin of the sound


|p2= sound: [[String]] - Classname of the sound to be played. Defined in [[Description.ext#CfgSounds|CfgSounds]] including [[Description.ext]]
|p2= sound: [[String]] - classname of the sound to be played. Defined in [[Description.ext#CfgSounds|CfgSounds]] including [[Description.ext]]


|r1= [[Object]] - The sound source (was [[Nothing]] before {{arma3}} v2.00)
|r1= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}})


|s2= from [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]
|s2= from [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]
Line 62: Line 62:
|p26since= arma3 2.00
|p26since= arma3 2.00


|r2= [[Object]] - The sound source (was [[Nothing]] before {{arma3}} v2.00)
|r2= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}})


|s3= [from, to] [[say3D]] sound
|s3= [from, to] [[say3D]] sound
Line 72: Line 72:
|p43= sound: [[String]] - Classname of the sound to be played. Defined in [[Description.ext#CfgSounds|CfgSounds]] including [[Description.ext]]
|p43= sound: [[String]] - Classname of the sound to be played. Defined in [[Description.ext#CfgSounds|CfgSounds]] including [[Description.ext]]


|r3= [[Object]] - The sound source (was [[Nothing]] before {{arma3}} v2.00)
|r3= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}})


|s4= [from, to] [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]
|s4= [from, to] [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]
Line 94: Line 94:
|p67since= arma3 2.00
|p67since= arma3 2.00


|r4= [[Object]] - The sound source (was [[Nothing]] before {{arma3}} v2.00)
|r4= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}})


|x1= <code>helicopter1 [[say3D]] "Fortunateson";</code>
|x1= <code>helicopter1 [[say3D]] "Fortunateson";</code>
Line 106: Line 106:
};</code>
};</code>


|x3= <code>{{cc|Since Arma 3 v2.00, the sound source is returned and can be deleted directly }}
|x3= <code>{{cc|Since {{arma3}} v2.00, the sound source is returned and can be deleted directly }}
_soundSrc = helicopter1 [[say3D]] "Fortunateson";
_soundSrc = helicopter1 [[say3D]] "Fortunateson";
[[sleep]] 5;
[[sleep]] 5;
Line 114: Line 114:
}}
}}


<dl class="command_description">
{{Note
 
|user= Rocket
<dt><dt>
|timestamp= 20130307131700
<dd class="notedate">Posted on 7 March 2013</dd>
|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.
<dt class="note">[[User:Rocket|Rocket]]</dt>
}}
<dd class="note">
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.
</dd>


<dt><dt>
{{Note
<dd class="notedate">Posted on July 19, 2015 - 21:26 (UTC)</dd>
|user= Benargee
<dt class="note">[[User:Benargee|Benargee]]</dt>
|timestamp= 20150619212600
<dd class="note">In {{arma2}} 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. <br>
|text= In {{arma2}} 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. <br>
Here is [http://forums.bistudio.com/showthread.php?146122-Making-a-dead-soldier-play-a-sound-in-3d a link to the forum] to get around this issue.<br>
Here is [http://forums.bistudio.com/showthread.php?146122-Making-a-dead-soldier-play-a-sound-in-3d a link to the forum] to get around this issue.<br>
I have not tested this in Arma 3 yet.
I have not tested this in {{arma3}} yet.
</dd>
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on March 11, 2017 - 14:43 (UTC)</dd>
|user= Killzone_Kid
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|timestamp= 20170311144300
<dd class="note">
|text= This command creates sound object "#soundonvehicle" which can be detected with [[allMissionObjects]]:
This command creates sound object "#soundonvehicle" which can be detected with [[allMissionObjects]]:
<code>[[onEachFrame]] {[[hintSilent]] [[str]] [[allMissionObjects]] "#soundonvehicle"};
<code>[[onEachFrame]] {[[hintSilent]] [[str]] [[allMissionObjects]] "#soundonvehicle"};
[] [[spawn]] {[[sleep]] 1; [[player]] [[say3D]] "Alarm"};</code>
[] [[spawn]] {[[sleep]] 1; [[player]] [[say3D]] "Alarm"};</code>
</dd>
}}
 
</dl>

Revision as of 23:55, 5 February 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
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 - (Optional, default false)
  • true = play as speech (fadeSpeech applies), filters are not applied to it (i.e. house or vehicle interior one)
  • false = play as sound, fadeSound applies
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 - (Optional, default false)
  • true = play as speech (fadeSpeech applies), filters are not applied to it (i.e. house or vehicle interior one)
  • false = play as sound, fadeSound applies
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)

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

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"};
Retrieved from "https://community.bistudio.com/wiki?title=say3D&oldid=308249"