say2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatting)
m (Text replacement - "(optional, default " to "(Optional, default ")
Line 39: Line 39:
|p22= sound: [[String]] - Class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p22= sound: [[String]] - Class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]


|p24= maxTitlesDistance: [[Number]] (optional, default 100) - Max. distance in meters at which the sound can be heard
|p24= maxTitlesDistance: [[Number]] (Optional, default 100) - Max. distance in meters at which the sound can be heard


|p25= speed: [[Number]] (optional, default 1) - Pitch of the sound
|p25= speed: [[Number]] (Optional, default 1) - Pitch of the sound


|r2= [[Nothing]]
|r2= [[Nothing]]
Line 63: Line 63:
|p63= sound: [[String]] - Class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]
|p63= sound: [[String]] - Class name of the sound to be played. Defined in CfgSounds including [[Description.ext]]


|p64= maxTitlesDistance: [[Number]] (optional, default 100) - Max. distance in meters at which the sound can be heard
|p64= maxTitlesDistance: [[Number]] (Optional, default 100) - Max. distance in meters at which the sound can be heard
   
   
|p65= speed: [[Number]] (optional, default 1) - Pitch of the sound
|p65= speed: [[Number]] (Optional, default 1) - Pitch of the sound


|r4= [[Nothing]]
|r4= [[Nothing]]

Revision as of 10:15, 23 April 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 - Class name 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: 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

Syntax 3

Syntax:
[from, to] say2D sound
Parameters:
from: Object - Origin of the sound
to: Object - Target
sound: String - Class name 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: Object - Origin of the sound
to: Object - Target
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:
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