say3D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|arg= global |Multiplayer Arguments=
|arg= global


|eff= local |Multiplayer Effects=
|eff= local


|gr1= Broken Commands |GROUP1=
|gr1= Broken Commands
|gr2= Sounds |GROUP2=
|gr2= Sounds


| Unit or object will say given sound in 3D Space.
| Unit or object will say given sound in 3D Space.
Line 19: Line 19:
{{Informative | You can stop [[say3D]] sound currently playing in 2 ways:
{{Informative | You can stop [[say3D]] sound currently playing in 2 ways:
* delete the source of the sound (from) with [[deleteVehicle]], or
* delete the source of the sound (from) with [[deleteVehicle]], or
* kill the source with e.g [[setDamage]].}} |DESCRIPTION=
* kill the source with e.g [[setDamage]].}}


|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. |PROBLEMS=
|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.


| from [[say3D]] sound |SYNTAX=
| from [[say3D]] sound


|p1= from: [[Object]] - origin of the sound
|p1= from: [[Object]] - origin of the sound
Line 29: Line 29:
|p2= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p2= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]


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


| s2 = from [[say3D]] [sound, maxDistance, pitch, isSpeech, offset] |SYNTAX2=
| s2 = from [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]


|p21= from: [[Object]] - origin of the sound
|p21= from: [[Object]] - origin of the sound
Line 46: Line 46:
|p26= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}} |PARAMETER26=
|p26= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}} |PARAMETER26=


|r2= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]] |RETURNVALUE2=
|r2= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]]


|s3= [from, to] [[say3D]] sound |SYNTAX3=
|s3= [from, to] [[say3D]] sound


|p41= from: [[Object]] - origin of the sound
|p41= from: [[Object]] - origin of the sound
Line 56: Line 56:
|p43= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p43= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]


|r3= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]] |RETURNVALUE3=
|r3= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]]


|s4 = [from, to] [[say3D]] [sound, maxDistance, pitch, isSpeech, offset] |SYNTAX4=
|s4 = [from, to] [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]


|p61= from: [[Object]] - origin of the sound
|p61= from: [[Object]] - origin of the sound
Line 75: Line 75:
|p67= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}} |PARAMETER47=
|p67= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}} |PARAMETER47=


|r4= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]] |RETURNVALUE4=
|r4= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]]


|x1= <code> helicopter1 [[say3D]] "Fortunateson"</code> |EXAMPLE1=
|x1= <code> helicopter1 [[say3D]] "Fortunateson"</code>


|x2= Workaround for dead bodies:
|x2= Workaround for dead bodies:
Line 85: Line 85:
[[sleep]] 5; {{cc|at least the length of your sound}}
[[sleep]] 5; {{cc|at least the length of your sound}}
[[deleteVehicle]] _this;
[[deleteVehicle]] _this;
};</code> |EXAMPLE2=
};</code>


| [[say]], [[say2D]], [[playSound]], [[createSoundSource]] |SEEALSO=
| [[say]], [[say2D]], [[playSound]], [[createSoundSource]]
}}
}}



Revision as of 12:05, 18 January 2021

Hover & click on the images for description

Description

Description:
Unit or object will 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.
You can stop say3D sound currently playing in 2 ways:
Problems:
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.
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:
Nothing, Template:Since Object

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) max distance in meter at which the sound can be heard.
pitch: Number - (Optional, default 1) pitch of the sound.
isSpeech: Boolean - play as speech through radio channel, fadeSpeech applies. If true, filters are not applied to it (i.e. house or vehicle interior one). Available since 1.91.145286
offset: Scalar - (Optional) Offset in seconds. Same with playMusic. Default: 0 Template:Since
Return Value:
Nothing, Template:Since Object

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

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) max distance in meter at which the sound can be heard.
pitch: Number - (Optional, default 1) pitch of the sound.
isSpeech: Boolean - play as speech through radio channel, fadeSpeech applies. If true, filters are not applied to it (i.e. house or vehicle interior one). Available since 1.91.145286
offset: Scalar - (Optional) Offset in seconds. Same with playMusic. Default: 0 Template:Since
Return Value:
Nothing, Template:Since Object

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; };

Additional Information

See also:
saysay2DplaySoundcreateSoundSource

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 7 March 2013
Rocket
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.
Posted on July 19, 2015 - 21:26 (UTC)
Benargee
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: [1]
I have not tested this in Arma 3 yet.
Posted on March 11, 2017 - 14:43 (UTC)
Killzone Kid
This command creates sound object "#soundonvehicle" which can be detected with allMissionObjects: onEachFrame {hintSilent str allMissionObjects "#soundonvehicle"}; [] spawn {sleep 1; player say3D "Alarm"};

Bottom Section