Arma 3 Scripting

Arma 3: Sound: SoundControllers

  • Also known as Arma 3 Sound: EnvironmentVariables, Arma 3 Sound: SoundControllers, Arma 3: Sound: EnvironmentVariables

Topic · Markdown · JSON · original wiki page

Sound Controllers

Sound controllers deliver data from the engine in real time which makes them perfect to control volumes and frequencies of sounds. If you want to monitor sound controllers, you can use these functions:

Command Usable On
getAllSoundControllers Vehicles
getSoundController Vehicles
getSoundControllerResult Vehicles
getAllEnvSoundControllers Positions
getEnvSoundController Positions
getAllEnv3DSoundControllers Environmental objects
getEnv3DSoundController Environmental objects
allEnv3DSoundSources Environmental objects

Also look at this forum post for a video showcase and a great and simple to use example mission.

Sound Controller Description / Notes type/range of value Usable in EnvSounds CfgWeapons CfgAmmo CfgVehicles (Land) CfgVehicles (Helicopter) CfgVehicles (Plane) CfgVehicles (Ship)
interior Surface texture name below character character starts with int_, character is inside building (time based transition, 0.8s) <0;1> ✓ ✗
houses local density of object type “building”, derived from map <0;1> ✓ ✓ ✓
meadow derived from map - probably outdated: getAllEnvSoundControllers returns meadows (A3 1.80) <0;1> ✓
meadows derived from map <0;1> ✓ ✓
forest local density of trees, derived from map <0;1> ✓ ✓ ✓
trees local density of trees (different settings), derived from map <0;1> ✓ ✓ ✓
sea derived from map <0;1> ✓ ✓ ✓
windy ambient map wind intensity (soundSetEnvironment). See getAllEnvSoundControllers <0;1> ✓ ✗ ✗ ✗ ✗ ✗ ✗
wind wind intensity. See getAllEnv3DSoundControllers <0;1> ✗ ✗ ✓ ✓ ✓
rain rain intensity. This controller is zeroed for all types when snow = true in RainParticles config <0;1> ✓ ✗ ✓ ✓ ✓
fog fog intensity <0;1> Unknown Unknown Unknown Unknown Unknown
daytime relative daytime (0 = midnight, 0.5 = noon) <0;1> ✓
night night time with transitions at ~17:30-18:00 and 07:00 – 07:15 <0;1> ✓ ✗
rainDrops Rain drop sound occlusion. How much the rain drops can be heard, 1 no occlusion 0 full occlusion. If 'snow' is set to true, rainDrops is 0 (3D Env controllers) <0;1> ✓
altitudeGround ground altitude m ✓ ✗
altitudeSea sea level altitude m ✓
coast precise sea shore detection, calculation includes high above sea level (~50m) <0;1> ✓ ✗ ✗
waterDepth sea depth - not available as EnvSoundController (A3 1.80) m ✓ ✗ ✓
distance distance to player? m Unknown
shooting firefight detection, 1 = no firefight, value is divided by 2 with every shot <0;1> ✓
deadBody presense of dead body (~10m) <0;1> ✓ ✗
rpm actual rpm of the vehicle engine rpm ✓ ✓ ✓
randomizer generates random number between 0 and 1 (once per live of instance) <0;1> ✓ ✓ ✓
speed actual speed of the vehicle m/s ✓ ✓ ✓
thrust thrust of the vehicle engine (acceleration) <0;1> ✓ ✓ ✓
camPos position of camera (0 = internal, 1 = external) <0;1> ✓ ✓ ✓
playerPos position of player within the vehicle (0 = front, 1 = Passenger) <0;1> ✓ ✓ ✓
engineOn state of vehicle engine 0/1 ✓ ✓ ✓
angVelocity speed of rotation (in all axes) ✓ ✓ ✓
gmeterZ accelleration meter ✓ ✓ ✓
roughness roughness of surface (0 = "glass") ✓
dustness roughness of surface (0 = no dust) ✓
damper0 dampers ✓
rock surface type ✓
sand surface type ✓
grass surface type ✓
mud surface type ✓
gravel surface type ✓
asphalt surface type ✓
water surface type ✓ ✓ ✓
latSlip ✓
latSlipDrive ✓
longSlip ✓
longSlipDrive ✓
lateralMovement ✓ ✓ ✓
machCone only for Jets, makes sure sound is within machCone, if not -> sound will be silent <0;1> ✓
gear ✓
flaps ✓
(buggy)
envelope ✓
rotorThrust ✓
rotorSpeed ✓
rotorDamage ✓
motorDamage ✓
transmissionDamage ✓
slingLoadActive ✓
scrubLand object is scrubbing terrain ✓ ✓
(VTOL,UAV)
✓
scrubObject object is scrubbing another object (vehicle ↔ vehicle) ✓
scrubTree object is scrubbing object type: tree ✓ ✓
(VTOL)
scrubBuilding object is scrubbing object type: building ✓ ✓
(VTOL,UAV)
scrubArmor object is scrubbing armored vehicle (tank) ✓
yearTime Time of the year in 0..1 range      (Since Arma 3 v2.07.148385) [0,1[ ✓
Arma 3 v2.08 ambientTemp Ambient air temperature, see ambientTemperature min..max world temperature in Celsius ✓
Arma 3 v2.08 snow 1 if "RainParticle" config 'snow' = true, 0 if false. When snow is 1, 'rainDrops' is 0 1 or 0 ✓