From fb284faa6611ebbdfcff9a7954223105b06de426 Mon Sep 17 00:00:00 2001 From: bux578 Date: Sat, 9 May 2015 08:18:44 +0200 Subject: [PATCH] adjust ambiance sound module description and docs --- addons/missionmodules/CfgVehicles.hpp | 14 +++++++------- documentation/missionmaker/modules.md | 25 ++++++++++++++++--------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/addons/missionmodules/CfgVehicles.hpp b/addons/missionmodules/CfgVehicles.hpp index 6a1dc71705..35a937c660 100644 --- a/addons/missionmodules/CfgVehicles.hpp +++ b/addons/missionmodules/CfgVehicles.hpp @@ -19,31 +19,31 @@ class CfgVehicles { class Arguments { class soundFiles { displayName = "Sounds"; - description = "Classnames of the ambiance sounds played. Seperated by ','. "; + description = "Class names of the ambiance sounds to be played. Seperated by ','"; typeName = "STRING"; defaultValue = ""; }; class minimalDistance { displayName = "Minimal Distance"; - description = "Minimal Distance"; + description = "Used for calculating a random position and sets the minimal distance between the players and the played sound file(s)"; typeName = "NUMBER"; defaultValue = 400; }; class maximalDistance { - displayName = "Maximal Distance"; - description = "Maximal Distance"; + displayName = "Maximum Distance"; + description = "Used for calculating a random position and sets the maximum distance between the players and the played sound file(s)"; typeName = "NUMBER"; defaultValue = 900; }; class minimalDelay { displayName = "Minimal Delay"; - description = "Minimal Delay between sounds played"; + description = "Minimal delay between sounds played"; typeName = "NUMBER"; defaultValue = 10; }; class maximalDelay { - displayName = "Maximal Delay"; - description = "Maximal Delay between sounds played"; + displayName = "Maximum Delay"; + description = "Maximum delay between sounds played"; typeName = "NUMBER"; defaultValue = 170; }; diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index 9cb17e001f..a6d75531dc 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -501,25 +501,32 @@ Whether or not the objects in the list will be a medical vehicle.
### 3.1 Ambiance Sounds -Used for ambiance sounds loop (synced across MP) +Used for ambiance sounds loop (synced across MP). + +This module randomizes the time when the sound file is played and the position where the sound file is played (If "Follow Players" is set to No). +`Minimal Distance` and `Maximal Distance` influence the position from where the sound file is played. Setting both values to 0 forces the module to play the sound from where it was placed in the editor. +`Minimal Delay` and `Maximal Delay` work in a similar fashion but are used to randomize when the sound file is played. Setting both values to 0 plays the sound from mission start. **Settings:** 1. **Sounds (String)**
-Class names of the ambiance sounds played. Separated by ','.
+Class names of the ambiance sounds played. Separated by ','. (Example: `radio_track_01, electricity_loop`).
`Default value: ""` 2. **Minimal Distance (Number)**
-Minimal Distance (in meters)
+Used for calculating a random position and sets the minimal distance between the players and the played sound file(s) (in meters)
`Default value: 400` -3. **Minimal Delay (Number)**
-Minimal Delay (in seconds) between sounds played
+3. **Maximum Distance (Number)**
+Used for calculating a random position and sets the maximum distance between the players and the played sound file(s) (in meters)
+`Default value: 900` +4. **Minimal Delay (Number)**
+Minimal delay (in seconds) between sounds played
`Default value: 10` -4. **Maximal Delay (Number)**
-Maximal Delay (in seconds) between sounds played
+5. **Maximum Delay (Number)**
+Maximum delay (in seconds) between sounds played
`Default value: 10` -5. **Follow Players (Boolean)**
+6. **Follow Players (Boolean)**
Follow players. If set to false, loop will play sounds only nearby logic position.
`Default value: No` -6. **Volume (Number)**
+7. **Volume (Number)**
The volume of the sounds played
`Default value: 1`