say3D: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Add isSpeech's Number description) |
Lou Montana (talk | contribs) m (Text replacement - "|size=0.75" to "|size= 0.75") |
||
Line 42: | Line 42: | ||
|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]] | ||
|r1= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}}) | |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 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]] or {{GVI|arma3|2.04|size=0.75}} [[Number]] - (Optional, default [[false]]) | |p25= isSpeech: [[Boolean]] or {{GVI|arma3|2.04|size= 0.75}} [[Number]] - (Optional, default [[false]]) | ||
* 0/[[false]] = play as sound ([[fadeSound]] applies) | * 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) | * 1/[[true]] = play as speech ([[fadeSpeech]] applies), filters are not applied to it (i.e. house or vehicle interior one) | ||
Line 63: | Line 63: | ||
|p26since= arma3 2.00 | |p26since= arma3 2.00 | ||
|r2= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}}) | |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 73: | Line 73: | ||
|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= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size=0.75}}) | |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 87: | 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]] or {{GVI|arma3|2.04|size=0.75}} [[Number]] - (Optional, default [[false]]) | |p66= isSpeech: [[Boolean]] or {{GVI|arma3|2.04|size= 0.75}} [[Number]] - (Optional, default [[false]]) | ||
* 0/[[false]] = play as sound ([[fadeSound]] applies) | * 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) | * 1/[[true]] = play as speech ([[fadeSpeech]] applies), filters are not applied to it (i.e. house or vehicle interior one) | ||
Line 96: | Line 96: | ||
|p67since= arma3 2.00 | |p67since= arma3 2.00 | ||
|r4= [[Object]] - the sound source ([[Nothing]] before {{GVI|arma3|2.00|size=0.75}}) | |r4= [[Object]] - the sound source ([[Nothing]] before {{GVI|arma3|2.00|size= 0.75}}) | ||
|x1= <sqf>helicopter1 say3D "FortunateSon";</sqf> | |x1= <sqf>helicopter1 say3D "FortunateSon";</sqf> |
Revision as of 12:09, 21 December 2022
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.
- 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 2.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 1.92
- isSpeech: Boolean or 2.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 2.00
- offset: Number - (Optional, default 0) Offset in seconds. Same as playMusic.
- Return Value:
- Object - the sound source (was Nothing before 2.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 2.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 2.00
- isSpeech: Boolean or 2.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 2.00
- offset: Number - (Optional, default 0) Offset in seconds. Same as playMusic.
- Return Value:
- Object - the sound source (Nothing before 2.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
- 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.
- 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.
- 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" };
Categories:
- Scripting Commands
- Introduced with Arma 2 version 1.00
- Arma 2: New Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Broken Commands
- Command Group: Sounds
- Scripting Commands: Local Effect