say: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofp |Game name=
| ofp |Game name=
Line 11: Line 10:


|gr1= Sounds |GROUP1=
|gr1= Sounds |GROUP1=
____________________________________________________________________________________________


| 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 corresponding lipsync effect provided an appropriate .lip file has been created for this sound.
| 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 corresponding lipsync effect provided an appropriate .lip file has been created for this sound.
Line 20: Line 18:


{{Informative | [[say]] will mimic either [[say2D]] or [[say3D]] depending on whether it is there executed in a cutscene or in a game scene.}} |DESCRIPTION=
{{Informative | [[say]] will mimic either [[say2D]] or [[say3D]] depending on whether it is there executed in a cutscene or in a game scene.}} |DESCRIPTION=
____________________________________________________________________________________________


| from [[say]] sound |SYNTAX=
| from [[say]] sound |SYNTAX=
Line 29: Line 26:


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________


|s2 = from [[say]] [sound, maxTitlesDistance, speed]|SYNTAX2=
|s2 = from [[say]] [sound, maxTitlesDistance, speed]|SYNTAX2=
Line 42: Line 38:


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________


|s3= [from, to] [[say]] sound |SYNTAX3=
|s3= [from, to] [[say]] sound |SYNTAX3=
Line 53: Line 48:


|r3= [[Nothing]] |RETURNVALUE3=
|r3= [[Nothing]] |RETURNVALUE3=
____________________________________________________________________________________________


|s4 = [from, to] [[say]] [sound, maxTitlesDistance, speed]|SYNTAX4=
|s4 = [from, to] [[say]] [sound, maxTitlesDistance, speed]|SYNTAX4=
Line 68: Line 62:


| r4= [[Nothing]] |RETURNVALUE4=
| r4= [[Nothing]] |RETURNVALUE4=
____________________________________________________________________________________________
   
   
|x1= <code>([[units]] [[player]] [[select]] 1) [[say]] ["whisper1", 5];</code> |EXAMPLE1=
|x1= <code>([[units]] [[player]] [[select]] 1) [[say]] ["whisper1", 5];</code> |EXAMPLE1=


|x2= Arma 3:<code>[[player]] [[say]] "scuba_breath";</code> |EXAMPLE2=
|x2= Arma 3:<code>[[player]] [[say]] "scuba_breath";</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[say3D]], [[say2D]], [[playSound]], [[createSoundSource]] |SEEALSO=  
| [[say3D]], [[say2D]], [[playSound]], [[createSoundSource]] |SEEALSO=  

Revision as of 02:18, 17 January 2021

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 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 there executed in a cutscene or in a game scene.
Groups:
Sounds

Syntax 1

Syntax:
from say sound
Parameters:
from: Object - origin of the sound
sound: String - sound classname
Return Value:
Nothing

Syntax 2

Syntax:
from say [sound, maxTitlesDistance, speed]
Parameters:
from: Object - origin of the sound
sound: String - sound classname
maxTitlesDistance: Number - max distance at which the sound can be heard. Default: 100 m.
speed: Number - (Optional, default 1) pitch of the sound
Return Value:
Nothing

Syntax 3

Syntax:
[from, to] say sound
Parameters:
from: Object - origin of the sound
to: Object - target
sound: String - sound classname
Return Value:
Nothing

Syntax 4

Syntax:
[from, to] say [sound, maxTitlesDistance, speed]
Parameters:
from: Object - origin of the sound
to: Object - target
sound: String - sound classname
maxTitlesDistance: Number - max distance at which the sound can be heard. Default: 100 m.
speed: Number - (Optional, default 1) pitch of the sound.
Return Value:
Nothing

Examples

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

Additional Information

See also:
say3Dsay2DplaySoundcreateSoundSource

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
Say will occur in 3D when the player is active, during cutscenes it will not. Use say3D to force 3D effect for cutscenes.

Bottom Section