Tutorials · Sound and Music · Chapter 5

Music

Three pieces of music

1. Download Abandoned Castle Music from its page below: the download is the one file. Copy it into your project’s audio folder, and press Refresh in the Assets panel.
2. Click it in audio, set its Stream to Always in Details, and press Save.
3. Leave crypt-calm.wav and music-box.wav on Auto.

The title’s music

1. Click the Levels tab, in the dock under the Viewport, and click the Title row.
2. Drag abandoned_castle_music_-_starninjas_6.ogg from Assets onto the row’s Music button. The button reads its name; the ▶ beside it plays it.
3. Leave The Crypt row’s Music empty.

A level’s Music, in the Levels panel

A sound that plays as the level’s scene opens, in the editor’s Play and in an exported game, as the game’s music: on the Music bus, from nowhere, looping. There is one music at a time: the level’s replaces what was playing, and a level that names the music already playing leaves it playing. Click the button to clear it.

The crypt’s own track

1. Select Crypt, the root of the crypt’s scene. Press Add component and choose AudioSourceComponent.
2. Set Clip to crypt-calm.wav, Bus to Music and Volume to 0.7. Tick Looping and Autoplay. In Spatial, untick Positional.
3. Press Ctrl+S.

The music box

1. Select music_box, in alcove. Press Add component and choose AudioSourceComponent.
2. Set Clip to music-box.wav and Volume to 0.3. Leave Bus on Sfx and Positional ticked. Tick Looping and Autoplay.
3. Set Max Distance to 128, Rolloff to Linear and Min Distance to 24.
4. Press Ctrl+S.

The alcove

1. Select alcove. Press Add component and choose AreaComponent. In its Shape, set Size to 160, 144: the alcove’s floor.
2. Press Add component and choose AudioSourceComponent. Leave Clip empty. Set Bus to Music and Volume to 0.7, the root’s, so the calm comes back as loud as it went. In Spatial, untick Positional.
3. Add a trigger calm, its Clip crypt-calm.wav.
4. In Assets, click Assets in the path bar, so the script is written at the project’s top, then click Create, choose New script, type alcove and press Enter. In the Code tab, replace everything in alcove.rgs with the script below, and press Ctrl+S.
5. Select alcove, press Add component and choose Alcove. Press Ctrl+S.

/// The alcove at the end of the crypt, where the music box plays. As the
/// knight comes in, the crypt's music stops, and the box is heard alone. As he
/// leaves, the crypt's music comes back, from its first bar.
component Alcove : Area {
    fn on_enter(other: NodeId) {
        if in_group(other, "knight") {
            stop_music();
        }
    }

    fn on_exit(other: NodeId) {
        if in_group(other, "knight") {
            // calm is the trigger on the alcove's own Audio Source: the
            // crypt's track, played as the music, which loops.
            play_music("calm");
        }
    }
}

The alcove’s Area Shape Size

The box that notices him, in world units, round the node’s middle: 160 by 144, the alcove’s floor, wall to wall, so on_enter runs as he comes in through the gate’s doorway and on_exit as he goes back out.

stop_music

Stops the game’s music, whoever asked for it: here the crypt’s own track. Sounds in the room, on Sfx, play on.

play_music

Starts a music by name. A name that is a trigger on the script’s own node’s Audio Source plays that row’s take as the game’s music: on the Music bus whatever the row says, from nowhere, looping whatever Looping says, and in place of whatever music was playing. Asking for the music already playing leaves it playing. Chapter 10 gives the crypt a music asset, whose tracks it names the same way.

Found by ear

1. Press F5 and click the Sound tab.
2. Go to the gate room, pull the lever, and walk up through the gate into the alcove, to the box. Then walk back out.
3. Press F5 again to stop.

The music

Check it works