say: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 23: Line 23:
Sound is defined in CfgSound of the [[Description.ext]].
Sound is defined in CfgSound of the [[Description.ext]].


<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
<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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| from '''say''' sound|= Syntax
| from '''say''' sound|SYNTAX=


|p1= from: [[Object]] - origin of the sound
|p1= from: [[Object]] - origin of the sound
|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]]


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=


| s2 = from '''say''' [sound, maxTitlesDistance, speed]|= Syntax
| s2 = from '''say''' [sound, maxTitlesDistance, speed]|SYNTAX=


|p21= from: [[Object]] - origin of the sound
|p21= from: [[Object]] - origin of the sound
Line 41: Line 41:
|p25= speed (Optional): [[Number]] - pitch of the sound. Default: 1.
|p25= speed (Optional): [[Number]] - pitch of the sound. Default: 1.


| r2= [[Nothing]] |= Return value
| r2= [[Nothing]] |RETURNVALUE=


| s3= [from, to] '''say''' sound|= Syntax
| s3= [from, to] '''say''' sound|SYNTAX=


|p41= [from, to]: [[Array]]
|p41= [from, to]: [[Array]]
Line 50: Line 50:
|p44= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p44= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]


| r3= [[Nothing]] |= Return value
| r3= [[Nothing]] |RETURNVALUE=


| s4 = [from, to] '''say''' [sound, maxTitlesDistance, speed]|= Syntax
| s4 = [from, to] '''say''' [sound, maxTitlesDistance, speed]|SYNTAX=


|p61= [from, to]: [[Array]]
|p61= [from, to]: [[Array]]
Line 62: Line 62:
|p67= speed (Optional): [[Number]] - pitch of the sound. Default: 1.
|p67= speed (Optional): [[Number]] - pitch of the sound. Default: 1.


| r4= [[Nothing]] |= Return value
| r4= [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>([[units]] [[player]] [[select]] 1) [[say]] ["whisper1",5];</code> |= Example 1
|x1= <code>([[units]] [[player]] [[select]] 1) [[say]] ["whisper1",5];</code> |EXAMPLE1=
|x2= Arma 3:<code>[[player]] [[say]] "scuba_breath";</code>|= Example 2
|x2= Arma 3:<code>[[player]] [[say]] "scuba_breath";</code>|EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


Revision as of 14:46, 7 April 2019

ofpr version.gif1.75
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Unit will say given sound. When the Unit is a Person, it will also perform corresponding lipsync effect provided an appropriate .lip file has been created for this sound. A unit that has been killed or does not exist will not say anything. Compare this with playSound which will always play a sound at the location of the player. If the camera is not within given range, title is not shown and the sound will not be heard. Sound is defined in CfgSound of the Description.ext.

NOTE: say will mimic either say2D or say3D depending on whether it is there executed in a cut scene or in a game scene.
Groups:
Uncategorised

Syntax 1

Syntax:
from say 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:
Nothing

Syntax 2

Syntax:
from say [sound, maxTitlesDistance, speed]
Parameters:
from: Object - origin of the sound
[sound, maxTitlesDistance, speed]: Array
sound: String - classname of the sound to be played. Defined in CfgSounds including Description.ext
maxTitlesDistance: Number - max distance at which the sound can be heard. Default: 100 m.
speed (Optional): Number - pitch of the sound. Default: 1.
Return Value:
Nothing

Syntax 3

Syntax:
[from, to] say sound
Parameters:
[from, to]: Array
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:
Nothing

Syntax 4

Syntax:
[from, to] say [sound, maxTitlesDistance, speed]
Parameters:
[from, to]: Array
from: Object - origin of the sound
to: Object - target
[sound, maxTitlesDistance, speed]: Array
sound: String - classname of the sound to be played. Defined in CfgSounds including Description.ext
maxTitlesDistance: Number - max distance at which the sound can be heard. Default: 100 m.
speed (Optional): Number - pitch of the sound. Default: 1.
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 for cutscenes.

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=say&oldid=122399"