say: Difference between revisions

Latest revision as of 15:17, 25 February 2023

1.00

Hover & click on the images for description

Description

Description:

Make unit say given sound. The sound is defined in CfgSounds. If the unit is a person, it will also perform the corresponding lipsync effect provided an appropriate .lip file has been created for this sound.

A dead or non-existent unit obviously cannot say anything.
If the camera is not within given range, title is not shown and the sound will not be heard.
See also playSound in order to play a sound wherever the camera/player is.

ⓘ

say will mimic either say2D or say3D depending on whether it is executed in a cutscene or in a game scene.

Groups:

Sounds

Syntax

Syntax:

from say sound

Parameters:

from: Object or Array of Objects

Object - the sound source
Array - format [from, to]:
- from: Object - sound source
- to: Object - target

sound: String or Array

String - class name of the sound to be played. Defined in CfgSounds including Description.ext
Array - format [sound, maxTitlesDistance, speed]:
- sound: String - class name of the sound to be played. Defined in CfgSounds including Description.ext
- maxTitlesDistance: Number (Optional, default 100) - max. distance in meters at which the sound can be heard
- speed: Number (Optional, default 1) - pitch of the sound

Return Value:

Nothing

Examples

Example 1:: (units player select 1) say ["whisper1", 5];
Example 2:: player say "scuba_breath"; // Arma 3 vanilla sound

Additional Information

See also:: say3D 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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|SAY]]
+{{RV|type=command
-[[Category:Scripting Commands OFP 1.97|SAY]]
-[[Category:Scripting Commands ArmA|SAY]]
+|game1= ofp
+|version1= 1.00
-<h2 style="color:#000066">'''''unit'' say ''speechname'''''</h2>
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2
+|version4= 1.00
-'''unit:''' [[Object]]
+|game5= arma2oa
+|version5= 1.50
-'''speechName:''' [[Array]]
+|game6= tkoh
+|version6= 1.00
-'''Type of returned value:'''
+|game7= arma3
+|version7= 0.50
-[[Nothing]]
+|arg= global
-'''Compatibility:'''
+|eff= local
-Added in version '''1.75'''
+|gr1= Sounds
-'''Description:'''
+|descr= Make unit say given sound. The sound is defined in [[Description.ext#CfgSounds|CfgSounds]].
+If the [[Object#Unit|unit]] is a [[Object#Person|person]], it will also perform the corresponding lipsync effect provided an appropriate [[Lip File Format|.lip file]] has been [[WaveToLip|created]] for this sound.
-Format of speechName is '''''[sound, maxTitlesDistance]'''''.
+* A dead or non-existent unit obviously cannot say anything.
+* If the camera is not within given range, title is not shown and the sound will not be heard.
+* See also [[playSound]] in order to play a sound wherever the [[cameraOn|camera/player]] is.
-Unit will say given sound.
+{{Feature|informative|[[say]] will mimic either [[say2D]] or [[say3D]] depending on whether it is executed in a cutscene or in a game scene.}}
-When unit is person, it will also perform corresponding lipsync effect providing an appropriate .lip file has been created for this sound.
+|s1= from [[say]] sound
-A unit that has been killed or does not exist will not '''say''' anything.  Compare this with [[playSound]] which will play a sound at the location of the player
+|p1= from: [[Object]] or [[Array]] of [[Object]]s
+* [[Object]] - the sound source
+* [[Array]] - format [from, to]:
+** from: [[Object]] - sound source
+** to: [[Object]] - target
-If camera is not withing given range, title is not shown and the sound will not be heard.
+|p2= sound: [[String]] or [[Array]]
+* [[String]] - class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]
+* [[Array]] - format [sound, maxTitlesDistance, speed]:
+** sound: [[String]] - class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]
+** maxTitlesDistance: [[Number]] (Optional, default 100) - max. distance in meters at which the sound can be heard
+** speed: [[Number]] (Optional, default 1) - pitch of the sound
-Sound is defined in [[Description.ext|description.ext]].
+|r1= [[Nothing]]
+|x1= <sqf>(units player select 1) say ["whisper1", 5];</sqf>
+|x2= <sqf>player say "scuba_breath"; // Arma 3 vanilla sound</sqf>
+|seealso= [[say3D]] [[say2D]] [[playSound]] [[createSoundSource]] [[playSoundUI]]
+}}