Document sound features for table authors #531
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
freezy
approved these changes
Mar 25, 2025
Owner
freezy
left a comment
freezy
left a comment
There was a problem hiding this comment.
Awesome doc, thanks! I've replaced the editor shots with a higher resolution and aligned them to the right side like in the rest of the doc.
Other comments below.
One thing you could also add is doc links in the code, so the ❓-icon of the component opens up the documentation. Example:
[HelpURL("https://docs.visualpinball.org/creators-guide/manual/sound.html")]|
|
||
| # Sound | ||
|
|
||
| Unity, the general purpose game engine VPE is built on top of, provides many |
Owner
There was a problem hiding this comment.
Suggested change
| Unity, the general purpose game engine VPE is built on top of, provides many | |
| Unity, the game engine VPE is built on top of, provides many |
| provides mixing and mastering functionality. For a comprehensive overview, refer | ||
| to the | ||
| [Unity documentation](https://docs.unity3d.com/6000.0/Documentation/Manual/Audio.html). | ||
| On top of this built in functionality, VPE provides some features specific to |
Owner
There was a problem hiding this comment.
Suggested change
| On top of this built in functionality, VPE provides some features specific to | |
| On top of this built-in functionality, VPE provides some features specific to |
| in your scene and play this clip directly, but VPE allows you to construct | ||
| different types of sound assets out of one or multiple of these audio clips to | ||
| produce variation and customize how the sound is played with pinball in mind. | ||
| VPE differentiates between sound effects, music and callouts. |
Owner
There was a problem hiding this comment.
Suggested change
| VPE differentiates between sound effects, music and callouts. | |
| VPE differentiates between **sound effects**, **music** and **callouts**. |
| produce variation and customize how the sound is played with pinball in mind. | ||
| VPE differentiates between sound effects, music and callouts. | ||
|
|
||
|  |
Owner
There was a problem hiding this comment.
You sure this screenshot is needed? It's explained just below how to do it.
| between callouts and sound effects is that callouts tend to be much more | ||
| significant to the player than other sounds. As such, their playback is managed | ||
| by a table-wide _Callout Coordinator_ component at the root of the table | ||
| hierarchy that ensures callouts are played one at a time. When triggering a |
Owner
There was a problem hiding this comment.
New paragraph?
Suggested change
| hierarchy that ensures callouts are played one at a time. When triggering a | |
| hierarchy that ensures callouts are played one at a time. | |
| When triggering a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.