Skip to content

Commit 8dc0938

Browse files
authored
Update RollOffMode.yaml to explain what distance is
Fix to explain what `distance` is, in reference to #935 (comment)
1 parent 5ba4198 commit 8dc0938

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

content/en-us/reference/engine/enums/RollOffMode.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,17 @@ items:
1616
summary: |
1717
Volume attenuates from `Class.Sound.RollOffMinDistance` in an inverse
1818
manner. This option mirrors how sounds attenuate in the real world.
19-
This is done through `Class.Sound.RollOffMinDistance`/`Distance`
19+
This is done through `Class.Sound.RollOffMinDistance`/`distance`,
20+
where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener.
2021
value: 0
2122
tags: []
2223
deprecation_message: ''
2324
- name: Linear
2425
summary: |
2526
Volume attenuates between `Class.Sound.RollOffMinDistance` and
2627
`Class.Sound.RollOffMaxDistance` with a linear relationship.
27-
This is done through (`Class.Sound.RollOffMaxDistance`/`Distance`)/(`Class.Sound.RollOffMaxDistance`-`Class.Sound.RollOffMinDistance`)
28+
This is done through (`Class.Sound.RollOffMaxDistance`/`distance`)/(`Class.Sound.RollOffMaxDistance`-`Class.Sound.RollOffMinDistance`),
29+
where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener.
2830
value: 1
2931
tags: []
3032
deprecation_message: ''
@@ -41,7 +43,8 @@ items:
4143
A hybrid model which follows the `Inverse` model when close to
4244
`Class.Sound.RollOffMinDistance` and the `LinearSquare` model when close
4345
to `Class.Sound.RollOffMaxDistance`.
44-
This is done through `Libraries.math.min`((`Class.Sound.RollOffMinDistance`/`Distance`)*`LinearSquare`)
46+
This is done through `Libraries.math.min`((`Class.Sound.RollOffMinDistance`/`distance`)*`LinearSquare`),
47+
where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener.
4548
value: 3
4649
tags: []
4750
deprecation_message: ''

0 commit comments

Comments
 (0)