Skip to content

Update RollOffMode.yaml to add the mathematical formulas for RolloffM… #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 13, 2025
Merged

Update RollOffMode.yaml to add the mathematical formulas for RolloffM… #935

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
665fc85
Update RollOffMode.yaml to add the mathematical formulas for RolloffM…
RedrcknRbn Dec 7, 2024
5ba4198
Merge branch 'main' into patch-1
RedrcknRbn Dec 10, 2024
8dc0938
Update RollOffMode.yaml to explain what `distance` is
RedrcknRbn Dec 10, 2024
6e2eacd
Merge branch 'main' into patch-1
RedrcknRbn Dec 10, 2024
27ffb0f
Apply suggestions from code review
IgnisRBX Dec 11, 2024
8c26f6c
Merge branch 'Roblox:main' into patch-1
RedrcknRbn Dec 11, 2024
e28ac73
Update content/en-us/reference/engine/enums/RollOffMode.yaml
IgnisRBX Dec 12, 2024
c30063a
Apply suggestions from code review
IgnisRBX Jan 13, 2025
1cb7e02
Merge branch 'main' into patch-1
IgnisRBX Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion content/en-us/reference/engine/enums/RollOffMode.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,26 @@ 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: ''
- name: Linear
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: ''
- name: LinearSquare
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: ''
Expand All @@ -38,6 +43,8 @@ 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 through `Libraries.math.min`((`Class.Sound.RollOffMinDistance`/`distance`)*`LinearSquare`),
where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener.
value: 3
tags: []
deprecation_message: ''
Loading