Sound: SoundControllers – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added table instead of listing)
m (fix typo)
 
(31 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category: Arma 3: Editing]][[Category:Arma 3: Sound|Controllers]]
== Sound Controllers ==


= 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:
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:
*[[getAllSoundControllers]] - can only be used on vehicles.
{| class="wikitable align-center-col-2"
*[[getSoundController]] - can only be used on vehicles.
! Command
*[[getSoundControllerResult]] - can only be used on vehicles.
! Usable On
*[[getAllEnvSoundControllers]] - can only be used on positions.
|-
*[[getEnvSoundController]] - can only be used on positions.
| [[getAllSoundControllers]]
| rowspan="3" | Vehicles
|-
| [[getSoundController]]
|-
| [[getSoundControllerResult]]
|-
| [[getAllEnvSoundControllers]]
| rowspan="2" | Positions
|-
| [[getEnvSoundController]]
|-
| [[getAllEnv3DSoundControllers]]
| rowspan="3" | Environmental objects
|-
| [[getEnv3DSoundController]]
|-
| [[allEnv3DSoundSources]]
|}


Also look at this [https://forums.bistudio.com/topic/187202-arma-3-sound-modding-101/?p=3049207 forum post] for a video showcase and a great and simple to use example mission.
Also look at this {{Link|https://forums.bistudio.com/topic/187202-arma-3-sound-modding-101/?p{{=}}3049207|forum post}} for a video showcase and a great and simple to use example mission.


{| border="1" class="sortable"
{| class="wikitable sortable align-center"
!Sound Controller
|- class="align-center"
!Description / Notes
! Sound Controller
!type/range of value
! Description / Notes
!Usable in EnvSounds
! type/range of value
!CfgWeapons
! Usable in EnvSounds
!CfgAmmo
! CfgWeapons
!CfgVehicles (Land)
! CfgAmmo
!CfgVehicles (Helicopter)
! CfgVehicles (Land)
!CfgVehicles (Plane)
! 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>
|
| {{Icon|checked}}
| {{Icon|unchecked}}
|
|
|
|
|-
|-
|houses
| houses
|local density of object type “building”, derived from map
| local density of object type “building”, derived from map
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|
|
|
|
|
|
|-
|-
|meadow
| meadow
|derived from map
| derived from map - probably outdated: getAllEnvSoundControllers returns meadows (A3 1.80)
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|
|
|
|
|
Line 42: Line 74:
|
|
|-
|-
|meadows
| meadows
|derived from map
| derived from map
|<0;1>
| <0;1>
|
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|Yes
|Yes
|
|
|
|
|
|
|-
|-
|forest
| forest
|local density of trees, derived from map
| local density of trees, derived from map
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|
|
|
|
|
|
|-
|-
|trees
| trees
|local density of trees (different settings), derived from map
| local density of trees (different settings), derived from map
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|
|
|
|
|
|
|-
|-
|interior
| sea
|Surface texture name below character character starts with int_, character is inside building (time based transition, 0.8s)
| derived from map
|<0;1>
| <0;1>
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|
|
|Yes
|Yes
|
|
|-
| '''windy'''
| ambient map wind intensity (soundSetEnvironment). See [[getAllEnvSoundControllers]]
| <0;1>
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
| '''wind'''
| wind intensity. See [[getAllEnv3DSoundControllers]]
| <0;1>
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|-
|-
|sea
| rain
|derived from map
| rain intensity. This controller is zeroed for all types when snow = true in RainParticles config
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|unchecked}}
|Yes
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|-
| fog
| fog intensity
| <0;1>
| {{Icon|unknown}}
| {{Icon|unknown}}
|
| {{Icon|unknown}}
| {{Icon|unknown}}
| {{Icon|unknown}}
|
|
|-
|-
|coast
| daytime
|precise sea shore detection, calculation includes high above sea level (~50m)
| relative daytime (0 = midnight, 0.5 = noon)
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|No
|
|Yes
|
|
|
|
|
|
|
|
|-
|-
|deadBody
| night
|presense of dead body (~10m)
| night time with transitions at ~17:30-18:00 and 07:00 – 07:15
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|No
| {{Icon|unchecked}}
|
|
|
|
|
Line 112: Line 184:
|
|
|-
|-
|windy
| rainDrops
|wind intensity
| 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>
| <0;1>
|Yes
| {{Icon|checked}}
|No
|
|
|
|
|
|
Line 122: Line 195:
|
|
|-
|-
|wind
| altitudeGround
|wind intensity
| ground altitude
|<0;1>
| m
| {{Icon|checked}}
| {{Icon|unchecked}}
|
|
|
|
|
|No
|
|
|Yes
|Yes
|Yes
|-
|-
|rain
| altitudeSea
|rain intensity
| sea level altitude
|<0;1>
| m
|Yes
| {{Icon|checked}}
|No
|
|
|
|Yes
|Yes
|Yes
|-
|night
|night time with transitions at ~17:30-18:00 and 07:00 – 07:15
|<0;1>
|Yes
|No
|
|
|
|
Line 152: Line 217:
|
|
|-
|-
|waterDepth
| coast
|sea depth
| precise sea shore detection, calculation includes high above sea level (~50m)
|m
| <0;1>
|Yes
| {{Icon|checked}}
|No
| {{Icon|unchecked}}
| {{Icon|checked}}
|
|
|
|Yes
|
|
|
|
|-
|-
|altitudeGround
| waterDepth
|gound altitude
| sea depth - not available as EnvSoundController (A3 1.80)
|m
| m
|Yes
| {{Icon|checked}}
|No
| {{Icon|unchecked}}
|
|
| {{Icon|checked}}
|
|
|
|
|
|
|-
|-
|altitudeSea
| distance
|sea level altitude
| distance to player?
|m
| m
|Yes
| {{Icon|unknown}}
|
|
|
|
|
Line 182: Line 250:
|
|
|-
|-
|daytime
| shooting
|relative daytime (0 = midnight, 0.5 = noon)
| firefight detection, 1 = no firefight, value is divided by 2 with every shot
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
|
|
|
|
|
Line 192: Line 261:
|
|
|-
|-
|shooting
| deadBody
|firefight detection, 1 = no firefight, value is divided by 2 with every shot
| presense of dead body (~10m)
|<0;1>
| <0;1>
|Yes
| {{Icon|checked}}
| {{Icon|unchecked}}
|
|
|
|
Line 202: Line 272:
|
|
|-
|-
|raindrops
| rpm
|presence/density of objects above SoundSource location
| actual rpm of the vehicle engine
|<0;1>
| rpm
|Yes
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|-
| randomizer
| generates random number between 0 and 1 (once per live of instance)
| <0;1>
|
|
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|-
|-
|rpm
| speed
|actual rpm of the vehicle engine
| actual speed of the vehicle
|rpm
| m/s
|
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|Yes
|Yes
|Yes
|-
|-
|randomizer
| thrust
|generates random number between 0 and 1 (once per live of instance)
| thrust of the vehicle engine (acceleration)
|<0;1>
| <0;1>
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|-
|-
|speed
| camPos
|actual speed of the vehicle
| position of camera (0 = internal, 1 = external)
|m/s
| <0;1>
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|-
|-
|thrust
| playerPos
|thrust of the vehicle engine (acceleration)
| position of player within the vehicle (0 = front, 1 = Passenger)
|<0;1>
| <0;1>
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|-
|-
|camPos
| engineOn
|position of camera (0 = internal, 1 = external)
| state of vehicle engine
|<0;1>
| 0/1
|
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|Yes
|Yes
|Yes
|-
|-
|playerPos
| angVelocity
|position of player within the vehicle (0 = front, 1 = Passenger)
| speed of rotation (in all axes)
|<0;1>
|
|
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|Yes
|Yes
|Yes
|-
|-
|engineOn
| gmeterZ
|state of vehicle engine
| accelleration meter
|0/1
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|Yes
| {{Icon|checked}}
|
|-
|-
|angVelocity
| roughness
|speed of rotation (in all axes)
| roughness of surface (0 = "glass")
|
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|Yes
|
|Yes
|
|
|-
|-
|gmeterZ
| dustness
|accelleration meter
| roughness of surface (0 = no dust)
|
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|Yes
|
|Yes
|
|
|-
|-
|roughness
| damper0
|roughness of surface (0 = "glass")
| dampers
|
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|
|
|
|
|
|-
|-
|dustness
| rock
|roughness of surface (0 = no dust)
| surface type
|
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|
|
|
|
|
|-
|-
|damper0
| sand
|dampers
| surface type
|
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|
|
|
|
|
|-
|-
|rock
| grass
|surface type
| surface type
|
|
|
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|
|
|-
|-
|sand
| mud
|surface type
| surface type
|
|
|
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|
|
|-
|-
|grass
| gravel
|surface type
| surface type
|
|
|
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|
|
|-
|-
|mud
| asphalt
|surface type
| surface type
|
|
|
|
| {{Icon|checked}}
|
|
|
|
|-
| water
| surface type
|
|
|
|
|
|
|Yes
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|-
|-
|gravel
| latSlip
|surface type
|
|
|
|
|
|
|
|
|
|Yes
| {{Icon|checked}}
|
|
|
|
|
|-
|-
|asphalt
| latSlipDrive
|surface type
|
|
|
|
|
|
|
|
|Yes
|
| {{Icon|checked}}
|
|
|
|
|
|-
|-
|latSlip
| longSlip
|
|
|
|
|
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|
|
|-
|-
|latSlipDrive
| longSlipDrive
|
|
|
|
|
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|
|
|-
|-
|longSlip
| lateralMovement
|
|
|
|
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|
|
|-
| machCone
| only for Jets, makes sure sound is within machCone, if not -> sound will be silent
| <0;1>
|
|
|Yes
|
|
|
|
|
| {{Icon|checked}}
|
|
|-
|-
|longSlipDrive
| gear
|
|
|
|
Line 428: Line 553:
|
|
|
|
|Yes
|
|
|
| {{Icon|checked}}
|
|
|-
|-
|lateralMovement
| flaps
|
|
|
|
|
|
Line 438: Line 566:
|
|
|
|
|Yes
| {{Icon|checked}}<br>(buggy)
|Yes
|
|Yes
|-
|-
|gear
| envelope
|
|
|
|
Line 448: Line 575:
|
|
|
|
|
| {{Icon|checked}}
|
|
|
|
|Yes
|-
|-
|flaps
| rotorThrust
|
|
|
|
Line 458: Line 586:
|
|
|
|
|
| {{Icon|checked}}
|
|
|
|
|Yes (buggy)
|-
|-
|rotorThrust
| rotorSpeed
|
|
|
|
|
Line 468: Line 598:
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|-
|-
|rotorSpeed
| rotorDamage
|
|
|
|
|
Line 478: Line 609:
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|-
|-
|rotorDamage
| motorDamage
|
|
|
|
|
Line 488: Line 620:
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|-
|-
|motorDamage
| transmissionDamage
|
|
|
|
|
Line 498: Line 631:
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|-
|-
|transmissionDamage
| slingLoadActive
|
|
|
|
Line 509: Line 642:
|
|
|
|
|Yes
| {{Icon|checked}}
|
|
|
|-
|-
|slingLoadActive
| scrubLand
| object is scrubbing terrain
|
|
|
|
Line 518: Line 653:
|
|
|
|
| {{Icon|checked}}
| {{Icon|checked}}<br>(VTOL,UAV)
| {{Icon|checked}}
|-
| scrubObject
| object is scrubbing another object (vehicle ↔ vehicle)
|
|
|
|
|
| {{Icon|checked}}
|
|
|Yes
|
|
|-
|-
|scrubLand
| scrubTree
|object is scrubbing terrain
| object is scrubbing object type: tree
|
|
|
|
Line 529: Line 675:
|
|
|
|
|Yes
| {{Icon|checked}}
| {{Icon|checked}}<br>(VTOL)
|
|
|-
|-
|scribObject
| scrubBuilding
|object is scrubbing another object (vehicle ↔ vehicle)
| object is scrubbing object type: building
|
|
|
|
Line 539: Line 686:
|
|
|
|
|Yes
| {{Icon|checked}}
| {{Icon|checked}}<br>(VTOL,UAV)
|
|
|-
|-
|scrubTree
| scrubArmor
|object is scrubbing object type: tree
| object is scrubbing armored vehicle (tank)
|
|
|
|
Line 549: Line 697:
|
|
|
|
|Yes
| {{Icon|checked}}
|
|
|
|-
|-
|scrubBuilding
| yearTime
|object is scrubbing object type: building
| Time of the year in 0..1 range &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''(Since Arma 3 v2.07.148385)''
| [0,1[
| {{Icon|checked}}
|
|
|
|
Line 559: Line 710:
|
|
|
|
|Yes
|
|
|-
|-
|scrubArmor
| {{GVI|arma3|2.08|size= 0.75}} ambientTemp
|object is scrubbing armored vehicle (tank)
| Ambient air temperature, see [[ambientTemperature]]
| min..max world temperature in Celsius
| {{Icon|checked}}
|
|
|
|
|
|
|-
| {{GVI|arma3|2.08|size= 0.75}} snow
| 1 if "RainParticle" config 'snow' = true, 0 if false. When snow is 1, 'rainDrops' is 0
| 1 or 0
| {{Icon|checked}}
|
|
|
|
Line 569: Line 732:
|
|
|
|
|Yes
|
|
|}
|}
{{GameCategory|arma3|Sound}}

Latest revision as of 14:48, 6 September 2023

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
getSoundControllerResult
getAllEnvSoundControllers Positions
getEnvSoundController
getAllEnv3DSoundControllers Environmental objects
getEnv3DSoundController
allEnv3DSoundSources

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