diff --git a/content/en-us/reference/engine/enums/RollOffMode.yaml b/content/en-us/reference/engine/enums/RollOffMode.yaml index 816641ab4..d0c64561d 100644 --- a/content/en-us/reference/engine/enums/RollOffMode.yaml +++ b/content/en-us/reference/engine/enums/RollOffMode.yaml @@ -15,7 +15,9 @@ items: - name: Inverse summary: | Volume attenuates from `Class.Sound.RollOffMinDistance` in an inverse - manner. This option mirrors how sounds attenuate in the real world. + manner, mirroring how sounds attenuate in the real world. + This is done through `Class.Sound.RollOffMinDistance`/`distance`, + where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener. value: 0 tags: [] deprecation_message: '' @@ -23,6 +25,8 @@ items: summary: | Volume attenuates between `Class.Sound.RollOffMinDistance` and `Class.Sound.RollOffMaxDistance` with a linear relationship. + This is done through (`Class.Sound.RollOffMaxDistance`/`distance`)/(`Class.Sound.RollOffMaxDistance`-`Class.Sound.RollOffMinDistance`), + where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener. value: 1 tags: [] deprecation_message: '' @@ -30,6 +34,7 @@ items: summary: | Volume attenuates between `Class.Sound.RollOffMinDistance` and `Class.Sound.RollOffMaxDistance` with a linear squared relationship. + This is done through squaring `Linear`. value: 2 tags: [] deprecation_message: '' @@ -38,6 +43,7 @@ items: A hybrid model which follows the `Inverse` model when close to `Class.Sound.RollOffMinDistance` and the `LinearSquare` model when close to `Class.Sound.RollOffMaxDistance`. + This is done by taking the lesser of `Inverse` and `LinearSquare`. value: 3 tags: [] deprecation_message: ''