say3D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|")
m (Fix default values and return values)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2


|1.00
|version1= 1.00


|arg= global
|arg= global
Line 12: Line 12:
|gr2= Sounds
|gr2= Sounds


| Unit or object will say given sound in 3D Space.
|descr= 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.
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.
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.
Line 23: Line 23:
|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= 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
|s1= 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 [[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]]


| [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]]
|r1= [[Object]] - the sound source (was [[Nothing]] before {{arma3}} v1.99.146480)


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


|p21= from: [[Object]] - origin of the sound
|p21= from: [[Object]] - origin of the sound
Line 41: Line 41:
|p24= pitch: [[Number]] - (Optional, default 1) pitch of the sound.
|p24= pitch: [[Number]] - (Optional, default 1) pitch of the sound.


|p25= isSpeech: [[Boolean]] - [[true]]: play as speech, [[fadeSpeech]] applies; [[false]]: play as sound, [[fadeSound]] applies.
|p25= isSpeech: [[Boolean]] - (Optional, default [[false]]) [[true]]: play as speech, [[fadeSpeech]] applies; [[false]]: play as sound, [[fadeSound]] applies.
If [[true]], filters are not applied to it (i.e. house or vehicle interior one). Available since 1.91.145286
If [[true]], filters are not applied to it (i.e. house or vehicle interior one). Available since 1.91.145286


|p26= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}}
|p26= offset: [[Scalar]] - (Optional, default 0) Offset in seconds. Same with [[playMusic]]. {{Since|arma3|1.99.146480|y}}


|r2= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]]
|r2= [[Object]] - the sound source (was [[Nothing]] before {{arma3}} v1.99.146480)


|s3= [from, to] [[say3D]] sound
|s3= [from, to] [[say3D]] 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]]
|r3= [[Object]] - the sound source (was [[Nothing]] before {{arma3}} v1.99.146480)


|s4 = [from, to] [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]
|s4 = [from, to] [[say3D]] [sound, maxDistance, pitch, isSpeech, offset]
Line 70: Line 70:
|p65= pitch: [[Number]] - (Optional, default 1) pitch of the sound.
|p65= pitch: [[Number]] - (Optional, default 1) pitch of the sound.


|p66= isSpeech: [[Boolean]] - [[true]]: play as speech, [[fadeSpeech]] applies; [[false]]: play as sound, [[fadeSound]] applies.
|p66= isSpeech: [[Boolean]] - (Optional, default [[false]]) [[true]] = play as speech ([[fadeSpeech]] applies), [[false]] = play as sound, [[fadeSound]] applies.
If [[true]], filters are not applied to it (i.e. house or vehicle interior one). Available since 1.91.145286
If [[true]], filters are not applied to it (i.e. house or vehicle interior one). {{Since|arma3|1.99.145286|y}}


|p67= offset: [[Scalar]] - (Optional) Offset in seconds. Same with [[playMusic]]. Default: 0 {{Since|arma3|1.99.146480|true}}
|p67= offset: [[Number]] - (Optional, default 0) Offset in seconds. Same with [[playMusic]]. {{Since|arma3|1.99.146480|y}}


|r4= [[Nothing]], {{Since|arma3|1.99.146480}} [[Object]]
|r4= [[Object]] - the sound source (was [[Nothing]] before {{arma3}} v1.99.146480)


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


|x2= Workaround for dead bodies:
|x2= Workaround for dead bodies:
Line 87: Line 87:
};</code>
};</code>


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


Revision as of 12:34, 12 February 2021

Logo A2.png1.00
GAGlobalLELocal
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:
Object - the sound source (was Nothing before Arma 3 v1.99.146480)

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 - (Optional, default false) true: play as speech, fadeSpeech applies; false: play as sound, fadeSound applies. If true, filters are not applied to it (i.e. house or vehicle interior one). Available since 1.91.145286
offset: Scalar - (Optional, default 0) Offset in seconds. Same with playMusic. Template:Since
Return Value:
Object - the sound source (was Nothing before Arma 3 v1.99.146480)

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 v1.99.146480)

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 - (Optional, default false) true = play as speech (fadeSpeech applies), false = play as sound, fadeSound applies. If true, filters are not applied to it (i.e. house or vehicle interior one). Template:Since
offset: Number - (Optional, default 0) Offset in seconds. Same with playMusic. Template:Since
Return Value:
Object - the sound source (was Nothing before Arma 3 v1.99.146480)

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