say2D: Difference between revisions

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


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


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


| Plays given sound in 2D|DESCRIPTION=
| Plays given sound in 2D|DESCRIPTION=
____________________________________________________________________________________________


| from [[say2D]] sound |SYNTAX=
| from [[say2D]] sound |SYNTAX=
Line 53: Line 50:


| r4= [[Nothing]] |RETURNVALUE4=
| r4= [[Nothing]] |RETURNVALUE4=
____________________________________________________________________________________________


|x1= <code>[[player]] [[say2D]] "HelloThere";</code> |Example 1=
|x1= <code>[[player]] [[say2D]] "HelloThere";</code> |Example 1=


|x2= <code><nowiki>[</nowiki>[[player]], _officer] [[say2D]] ["HelloThere", 50, 0.9];</code> |Example 2=
|x2= <code><nowiki>[</nowiki>[[player]], _officer] [[say2D]] ["HelloThere", 50, 0.9];</code> |Example 2=
____________________________________________________________________________________________


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

Revision as of 02:20, 17 January 2021

Hover & click on the images for description

Description

Description:
Plays given sound in 2D
Groups:
Sounds

Syntax 1

Syntax:
from say2D 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 say2D [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] say2D 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] say2D [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:
player say2D "HelloThere";
Example 2:
[player, _officer] say2D ["HelloThere", 50, 0.9];

Additional Information

See also:
saysay3DplaySoundcreateSoundSource

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

Bottom Section