say: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofpr |= Game name
|game1= ofp
|version1= 1.00


|1.75|= Game version
|game2= ofpe
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= local |Multiplayer Effects=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Unit will say given sound.
|game5= arma2oa
|version5= 1.50


When 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.
|game6= tkoh
|version6= 1.00


A unit that has been killed or does not exist will not say anything.
|game7= arma3
|version7= 0.50


Compare this with [[playSound]] which will always play a sound at the location of the player.
|arg= global


If the camera is not within given range, title is not shown and the sound will not be heard.
|eff= local


Sound is defined in CfgSound of the [[Description.ext]].
|gr1= Sounds


<br><br>NOTE: [[say]] will mimic either [[say2D]] or [[say3D]] depending on whether it is there executed in a cut scene or in a game scene. |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.


| from '''say''' sound|SYNTAX=
* 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.


|p1= from: [[Object]] - origin of the sound
{{Feature|informative|[[say]] will mimic either [[say2D]] or [[say3D]] depending on whether it is executed in a cutscene or in a game scene.}}
|p2= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]


| [[Nothing]] |RETURNVALUE=
|s1= from [[say]] sound


| s2 = from '''say''' [sound, maxTitlesDistance, speed]|SYNTAX=
|p1= from: [[Object]] or [[Array]] of [[Object]]s
* [[Object]] - the sound source
* [[Array]] - format [from, to]:
** from: [[Object]] - sound source
** to: [[Object]] - target


|p21= from: [[Object]] - origin of the sound
|p2= sound: [[String]] or [[Array]]
|p22= [sound, maxTitlesDistance, speed]: [[Array]]
* [[String]] - class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p23= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]
* [[Array]] - format [sound, maxTitlesDistance, speed]:
|p24= maxTitlesDistance: [[Number]] - max distance at which the sound can be heard. Default: 100 m.
** sound: [[String]] - class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p25= speed (Optional): [[Number]] - pitch of the sound. Default: 1.
** 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


| r2= [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


| s3= [from, to] '''say''' sound|SYNTAX=
|x1= <sqf>(units player select 1) say ["whisper1", 5];</sqf>


|p41= [from, to]: [[Array]]
|x2= <sqf>player say "scuba_breath"; // Arma 3 vanilla sound</sqf>
|p42= from: [[Object]] - origin of the sound
|p43= to: [[Object]] - target
|p44= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]
 
| r3= [[Nothing]] |RETURNVALUE=
 
| s4 = [from, to] '''say''' [sound, maxTitlesDistance, speed]|SYNTAX=
 
|p61= [from, to]: [[Array]]
|p62= from: [[Object]] - origin of the sound
|p63= to: [[Object]] - target
|p64= [sound, maxTitlesDistance, speed]: [[Array]]
|p65= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p66= maxTitlesDistance: [[Number]] - max distance at which the sound can be heard. Default: 100 m.
|p67= speed (Optional): [[Number]] - pitch of the sound. Default: 1.
 
| r4= [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>([[units]] [[player]] [[select]] 1) [[say]] ["whisper1",5];</code> |EXAMPLE1=
|x2= Arma 3:<code>[[player]] [[say]] "scuba_breath";</code>|EXAMPLE2=
____________________________________________________________________________________________
 
| [[say3D]], [[say2D]], [[playSound]], [[createSoundSource]] |SEEALSO=


|seealso= [[say3D]] [[say2D]] [[playSound]] [[createSoundSource]] [[playSoundUI]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 7 March 2013
<dt class="note">[[User:Rocket|Rocket]]<dd class="note">
Say will occur in 3D when the player is active, during cutscenes it will not. Use [[say3D]] for cutscenes.
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SAY]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SAY]]
[[Category:Scripting Commands ArmA|SAY]]
[[Category:Scripting Commands ArmA2|SAY]]
[[Category:Scripting Commands Arma 3|SAY]]
[[Category:Command_Group:_Sounds|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:17, 25 February 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
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
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
Retrieved from "https://community.bistudio.com/wiki?title=say&oldid=338267"