say2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added Parameter)
(alt syntaxes)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Same as [[say]] only sound is mono. |= Description
| Plays given sound in mono |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


|unit '''say2D''' speechName |= Syntax
| from '''say2D''' sound|= Syntax


|p1= unit: [[Object]] - |= PARAMETER1
|p1= from: [[Object]] - origin of the sound
|p2= sound: [[String]] - classname of the sound to be played. Defined in CfgSounds including [[Description.ext]]


|p2= speechName: [[String]] |= PARAMETER2
| [[Nothing]] |= Return value


| [[Nothing]] |= RETURNVALUE
| s2 = from '''say2D''' [sound, maxTitlesDistance, speed]|= Syntax


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


|s2= [unit, target] '''say2D''' speechName
| r2= [[Nothing]] |= Return value


|p21= [unit, target]: [[Array]] |= PARAMETER1
| s3= [from, to] '''say2D''' sound|= Syntax


|p22= unit: [[Object]] - |= PARAMETER2
|p41= [from, to]: [[Array]]
|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]]


|p23= target: [[Object]] - |=PARAMETER3
| r3= [[Nothing]] |= Return value


|p24= speechName: [[String]] |= Parameter4
| s4 = [from, to] '''say2D''' [sound, maxTitlesDistance, speed]|= Syntax


|r2= [[Nothing]] |= RETURNVALUE
|p61= [from, to]: [[Array]]
 
|p62= from: [[Object]] - origin of the sound
 
|p63= to: [[Object]] - target
 
|p64= [sound, maxTitlesDistance, speed]: [[Array]]
|x1= |= EXAMPLE1
|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]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


Revision as of 18:55, 26 January 2016

Logo A2.png1.00
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Plays given sound in mono
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

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