Difference between revisions of "playSound3D"
Jump to navigation
Jump to search
m (Add max value for volume) |
Lou Montana (talk | contribs) (Add example and remove comments) |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Command|= | + | {{Command|Comments= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| − | | arma3 | | + | | arma3 |Game name= |
| − | |0.50| | + | |0.50|Game version= |
| − | |arg= global |= | + | |arg= global |Multiplayer Arguments= |
| − | |eff= global |= | + | |eff= global |Multiplayer Effects= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| − | | Plays positional sound with given filename on every computer on network. At least 2 parameters must be specified. | + | | Plays positional sound with given filename on every computer on network. At least 2 parameters must be specified. |
| + | {{Important | Since A3 v1.91.145537 the maximum volume allowed is '''5'''. Exceeding this will result in sound not being played when executed remotely.}} |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| − | | | + | | [[playSound3D]] [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset] |SYNTAX= |
| − | |p1= [ | + | |p1= filename: [[String]] - see [[Arma 3: SoundFiles]] for available filenames or [[#Examples|Example 3]] to use mission files. |PARAMETER1= |
| − | |p2= | + | |p2= soundSource: [[Object]] - the object emitting the sound. If "sound position" is specified this parameter is ignored |PARAMETER2= |
| − | |p3= | + | |p3= isInside: [[Boolean]] - (Optional, default [[false]]) |PARAMETER3= |
| − | |p4= | + | |p4= soundPosition: [[PositionASL]] - (Optional, default [0,0,0]) position for sound emitter, will override "sound source" position. |PARAMETER4= |
| − | |p5= | + | |p5= volume: [[Number]] - (Optional, default 1) Maximum value: 5 (limited since A3 v1.91.145537) |PARAMETER5= |
| − | |p6= | + | |p6= soundPitch: [[Number]] - (Optional, default 1) 1: Normal, 0.5: Darth Vader, 2: Chipmunks, etc. |PARAMETER6= |
| − | |p7= | + | |p7= distance: [[Number]] - (Optional, default 0) How far is sound audible (0 {{=}} no max distance) |PARAMETER7= |
| − | |p8= | + | |p8= offset: [[Scalar]] - (Optional, default 0) Offset in seconds. Same as with [[playMusic]] {{since|arma3|1.99.146480|true}} |PARAMETER8= |
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
| + | |x1= <code>[[playSound3D]] ["A3\Sounds_F\sfx\blip1.wav", [[player]]]</code> |EXAMPLE1= | ||
| − | | | + | |x2= <code>[[playSound3D]] ["A3\Sounds_F\sfx\blip1.wav", [[player]], [[false]], [[getPosASL]] [[player]], 1, 1, 0]</code> |EXAMPLE2= |
| − | | | + | |
| − | | | + | |x3= <code>[[playSound3D]] [<nowiki/>[[getMissionPath]] "mySound.ogg", [[player]]]; {{cc|to play a mission directory sound}}</code> |EXAMPLE3= |
| − | <code>[[playSound3D]] ["A3\Sounds_F\sfx\alarm_independent", [[player]]]; | + | |
| − | [[playSound3D]] ["A3\Sounds_F\sfx\alarm_independent.wss", [[player]]]; | + | |x4= Sound file extension must be specified even if a config entry has none: |
| + | <code>[[playSound3D]] ["A3\Sounds_F\sfx\alarm_independent", [[player]]]; {{cc|no sound}} | ||
| + | [[playSound3D]] ["A3\Sounds_F\sfx\alarm_independent.wss", [[player]]]; {{cc|alarm}}</code> |EXAMPLE4= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| − | | [[say3D]], [[playSound]], [[say2D]], [[say]], [[createSoundSource]] [[setRandomLip]] |SEEALSO= | + | | [[say3D]], [[playSound]], [[say2D]], [[say]], [[createSoundSource]], [[setRandomLip]], [[getMissionPath]] |SEEALSO= |
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
| Line 53: | Line 57: | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<dd class="notedate">Posted on September 26, 2014 - 09:18 (UTC)</dd> | <dd class="notedate">Posted on September 26, 2014 - 09:18 (UTC)</dd> | ||
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | ||
| Line 74: | Line 62: | ||
Currently, [[playSound3D]] is not JIP compatible, so joining players will not hear the sound if is started before and is still playing when player joins. | Currently, [[playSound3D]] is not JIP compatible, so joining players will not hear the sound if is started before and is still playing when player joins. | ||
</dd> | </dd> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<dd class="notedate">Posted on November 8, 2014 - 21:48 (UTC)</dd> | <dd class="notedate">Posted on November 8, 2014 - 21:48 (UTC)</dd> | ||
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | ||
| Line 94: | Line 68: | ||
When object is supplied but not a position, the position is taken from object, otherwise the position is taken from supplied position. That doesn't mean that when position is taken from object it is going to follow object when it changes position. The sound is generated at object position and it stays there.<br><br>One other important note: If <i>soundSource</i> param is [[objNull]] then his command develops the same bug with first person view as [[createSoundSource]] and [[say3D]]. If <i>soundSource</i> param is [[player]] then the bug is inverted. It seems that passing [[vehicle]] [[player]] as <i>soundSource</i> param is the only way to make it behave correctly when vehicles involved. | When object is supplied but not a position, the position is taken from object, otherwise the position is taken from supplied position. That doesn't mean that when position is taken from object it is going to follow object when it changes position. The sound is generated at object position and it stays there.<br><br>One other important note: If <i>soundSource</i> param is [[objNull]] then his command develops the same bug with first person view as [[createSoundSource]] and [[say3D]]. If <i>soundSource</i> param is [[player]] then the bug is inverted. It seems that passing [[vehicle]] [[player]] as <i>soundSource</i> param is the only way to make it behave correctly when vehicles involved. | ||
</dd> | </dd> | ||
| + | |||
| + | <!-- Note Section END --> | ||
</dl> | </dl> | ||
| − | < | + | |
| + | <h3 style='display:none'>Bottom Section</h3> | ||
Latest revision as of 13:22, 12 July 2020
0.50
Hover & click on the images for descriptions
Description
- Description:
- Plays positional sound with given filename on every computer on network. At least 2 parameters must be specified.
Syntax
- Syntax:
- playSound3D [filename, soundSource, isInside, soundPosition, volume, soundPitch, distance, offset]
- Parameters:
- filename: String - see Arma 3: SoundFiles for available filenames or Example 3 to use mission files.
- soundSource: Object - the object emitting the sound. If "sound position" is specified this parameter is ignored
- isInside: Boolean - (Optional, default false)
- soundPosition: PositionASL - (Optional, default [0,0,0]) position for sound emitter, will override "sound source" position.
- volume: Number - (Optional, default 1) Maximum value: 5 (limited since A3 v1.91.145537)
- soundPitch: Number - (Optional, default 1) 1: Normal, 0.5: Darth Vader, 2: Chipmunks, etc.
- distance: Number - (Optional, default 0) How far is sound audible (0 = no max distance)
- offset: Scalar - (Optional, default 0) Offset in seconds. Same as with playMusic Since Arma 3 v1.99.146480
- Return Value:
- Nothing
Examples
- Example 1:
-
playSound3D ["A3\Sounds_F\sfx\blip1.wav", player] - Example 2:
-
playSound3D ["A3\Sounds_F\sfx\blip1.wav", player, false, getPosASL player, 1, 1, 0] - Example 3:
-
playSound3D [getMissionPath "mySound.ogg", player]; // to play a mission directory sound - Example 4:
- Sound file extension must be specified even if a config entry has none:
playSound3D ["A3\Sounds_F\sfx\alarm_independent", player]; // no sound playSound3D ["A3\Sounds_F\sfx\alarm_independent.wss", player]; // alarm
Additional Information
Notes
Notes
- Posted on September 26, 2014 - 09:18 (UTC)
- Killzone Kid
- Currently, playSound3D is not JIP compatible, so joining players will not hear the sound if is started before and is still playing when player joins.
- Posted on November 8, 2014 - 21:48 (UTC)
- Killzone Kid
-
When object is supplied but not a position, the position is taken from object, otherwise the position is taken from supplied position. That doesn't mean that when position is taken from object it is going to follow object when it changes position. The sound is generated at object position and it stays there.
One other important note: If soundSource param is objNull then his command develops the same bug with first person view as createSoundSource and say3D. If soundSource param is player then the bug is inverted. It seems that passing vehicle player as soundSource param is the only way to make it behave correctly when vehicles involved.
