say2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| from '''say2D''' sound|= Syntax
| from '''say2D''' 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 '''say2D''' [sound, maxTitlesDistance, speed]|= Syntax
| s2 = from '''say2D''' [sound, maxTitlesDistance, speed]|SYNTAX=


|p21= from: [[Object]] - origin of the sound
|p21= from: [[Object]] - origin of the sound
Line 29: Line 29:
|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] '''say2D''' sound|= Syntax
| s3= [from, to] '''say2D''' sound|SYNTAX=


|p41= [from, to]: [[Array]]
|p41= [from, to]: [[Array]]
Line 38: Line 38:
|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] '''say2D''' [sound, maxTitlesDistance, speed]|= Syntax
| s4 = [from, to] '''say2D''' [sound, maxTitlesDistance, speed]|SYNTAX=


|p61= [from, to]: [[Array]]
|p61= [from, to]: [[Array]]
Line 50: Line 50:
|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=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 14:46, 7 April 2019

Hover & click on the images for description

Description

Description:
Plays given sound in 2D
Groups:
Uncategorised

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

Examples:
Example needed

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