say3D: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|game([0-9])= *([^ ]+) * +\|version([0-9])= *([^ ]+) * " to "|game$1=$2 |version$3=$4 ") |
m (2.16 -> 2.18) |
||
(49 intermediate revisions by 5 users not shown) | |||
Line 5: | Line 5: | ||
|game2= arma2oa | |game2= arma2oa | ||
|version2= 1. | |version2= 1.50 | ||
|game3= tkoh | |game3= tkoh | ||
Line 17: | Line 17: | ||
|eff= local | |eff= local | ||
|gr1 | |gr1= Sounds | ||
|descr= Lets an object say given sound in 3D space. | |descr= 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. | 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. | ||
Sound is defined in | Sound is defined in {{Link|Description.ext#CfgSounds|"CfgSounds"}} of the [[Description.ext]] or main config. | ||
{{Feature | | {{Feature|informative| | ||
* delete the source | * an object can only "say" '''one''' sound at a time | ||
* kill the source with e.g [[setDamage]].}} | * in order to stop a [[say3D]] sound: | ||
** delete the returned '''sound source''' with [[deleteVehicle]], or | |||
** 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]]). | |||
* forcing the speed of sound simulation: | |||
** may delay the queued sound to play right after the previous sound, even if the second sound does not simulate sound delay (e.g sound 1 plays with a 5s delay, ends, ''then'' sound 2 plays) | |||
** if the queued sound uses speed of sound simulation, it will be delayed from the end of the first sound (they will not follow "as expected") | |||
** makes the ''offset'' parameter ignored. | |||
}} | |||
|pr= | |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]] - | |p1= from: [[Object]] or [[Array]] of [[Object]]s | ||
* [[Object]] - origin of the sound | |||
* [[Array]] - format is [from, to] where: | |||
** from: [[Object]] - origin of the sound | |||
** to: [[Object]] - target | |||
|p2= sound: [[String]] - | |p2= sound: [[String]] or [[Array]] | ||
* [[String]] - classname of the sound to be played. Defined in [[CfgSounds]] including [[Description.ext]] | |||
* [[Array]] format [sound, maxDistance, pitch, isSpeech, offset, simulateSpeedOfSound] where: | |||
** sound: [[String]] - classname of the sound to be played. Defined in [[Description.ext#CfgSounds|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 | |||
** {{GVI|arma3|1.92|size= 0.75}} isSpeech: [[Boolean]] or {{GVI|arma3|2.04|size= 0.75}} [[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 | |||
** {{GVI|arma3|2.00|size= 0.75}} offset: [[Number]] - (Optional, default 0) offset in seconds; ignored when ''simulateSpeedOfSound'' is used | |||
** {{GVI|arma3|2.18|size= 0.75}} simulateSpeedOfSound: [[Boolean]] - (Optional, default [[false]]) [[true]] to simulate speed of sound (see description note) | |||
|r1= [[Object]] - | |r1= [[Object]] - the sound source (was [[Nothing]] before {{GVI|arma3|2.00|size= 0.75}}) | ||
| | |x1= All possible combinations: | ||
<sqf> | |||
helicopter1 say3D "FortunateSon"; | |||
helicopter1 say3D ["FortunateSon", 500, 1, 0, 0, true]; | |||
[helicopter1, player] say3D "FortunateSon"; | |||
[helicopter1, player] say3D ["FortunateSon", 500, 1, 0, 0, true]; | |||
</sqf> | |||
| | |x2= Workaround for dead bodies: | ||
<sqf> | |||
private _dummy = "#particlesource" createVehicleLocal ASLToAGL getPosWorld _corpse; | |||
_dummy say3D "whatever"; | |||
_dummy spawn { | |||
sleep 5; // at least the length of your sound | |||
deleteVehicle _this; | |||
}; | |||
</sqf> | |||
| | |x3= <sqf> | ||
// Since {{arma3}} 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 | |||
</sqf> | |||
| | |seealso= [[say]] [[say2D]] [[playSound]] [[playSound3D]] [[createSoundSource]] [[playSoundUI]] [[setRandomLip]] | ||
}} | |||
| | {{Note | ||
|user= Rocket | |||
|timestamp= 20130307131700 | |||
|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. | |||
}} | |||
{{Note | |||
|user= Benargee | |||
|timestamp= 20150619212600 | |||
|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 {{Link|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 {{arma3}} yet. | |||
| | }} | ||
| | |||
| | |||
| | {{Note | ||
|user= Killzone_Kid | |||
| | |timestamp= 20170311144300 | ||
|text= This command creates sound object "#soundonvehicle" which can be detected with [[allMissionObjects]]: | |||
<sqf> | |||
onEachFrame { hintSilent str allMissionObjects "#soundonvehicle" }; | |||
0 spawn { sleep 1; player say3D "Alarm" }; | |||
</sqf> | |||
}} | }} | ||
Latest revision as of 16:06, 8 February 2024
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:
- Sounds
Syntax
- Syntax:
- from say3D sound
- Parameters:
- from: Object or Array of Objects
- sound: String or Array
- String - classname of the sound to be played. Defined in CfgSounds including Description.ext
- Array format [sound, maxDistance, pitch, isSpeech, offset, simulateSpeedOfSound] where:
- 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
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
2.00 offset: Number - (Optional, default 0) offset in seconds; ignored when simulateSpeedOfSound is used
2.18 simulateSpeedOfSound: Boolean - (Optional, default false) true to simulate speed of sound (see description note)
- Return Value:
- Object - the sound source (was Nothing before
2.00)
Examples
- Example 1:
- All possible combinations:
- 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
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" }; 0 spawn { sleep 1; player say3D "Alarm" };