Skip to content

Commit f21878e

Browse files
committed
umprove audio tutorial section
1 parent 374c706 commit f21878e

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- next-header -->
22
## [Unreleased] - ReleaseDate
33

4+
### Improved
5+
6+
- Clarified the audio sections of the tutorial.
7+
48
## [5.0.5] - 2022-05-10
59

610
### Improved

tutorial/src/200-audio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Audio
22

3-
Rusty Engine has a basic audio system. You can play one looping music track, and quite a few concurrent sound effects. There are some music and sound effect files included in the asset pack.
3+
Rusty Engine has a basic audio system. You can play one looping music track, and quite a few concurrent sound effects. There are some music and sound effect files included in the asset pack which can be used via the `MusicPreset` and `SfxPreset` enums, respectively.
44

55
Supported audio file formats are `ogg`, `mp3`, `flac`, and `wav`.
66

tutorial/src/205-music.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Music
22

3-
One music file may be played at a time. Music always loops repeatedly until explicitly stopped (or the program exits). As with other `Engine` fields, the audio manager is also available through the `Game` in your `main` function:
3+
One music file may be played at a time. Music always loops repeatedly until explicitly stopped (or the program exits). As with other `Engine` fields, the audio manager is also available through the `Game` struct in your `main` function.
44

55
### Play
66

@@ -16,11 +16,11 @@ game.audio_manager.play_music(MusicPreset::Classy8Bit, 1.0);
1616
game.audio_manager.play_music("audio/music/Classy 8-Bit.ogg", 1.0);
1717
```
1818

19-
Any music already playing will be stopped to play a new music selection.
19+
Any music already playing will be stopped when `play_music` is called.
2020

2121
### Stop
2222

23-
The `stop_music` method stops any music that is playing. If no music is playing, it is a no-op.
23+
The `stop_music` method stops any music that is already playing.
2424

2525
```rust,ignored
2626
engine.audio_manager.stop_music();

tutorial/src/210-sfx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ engine.audio_manager.play_sfx(SfxPreset::Jingle1, 1.0);
1616
engine.audio_manager.play_sfx("audio/sfx/jingle1.ogg", 1.0);
1717
```
1818

19-
There is no way to interact with sound effects to monitor status or stop them early.
19+
There is no way to interact with sound effects.

0 commit comments

Comments
 (0)