Skip to content

Music

You can create, play, or pause musics through sol.music.

An object of type music represents a music with its current playing state. Multiple musics effects can be played, paused, resumed or stopped independently.

Musics are played into an audio context. The context parameter accepted by sol.music.create() is available in quest format 2.1 and later. With an earlier quest format, musics always play in the global context of sol.main and this function does not accept this extra parameter.

Functions of sol.music

sol.music.create([context,] music_id)

Creates a new music but does not play it. Generates a Lua error if the music file does not exist.

context (sol.main, game or map, optional, default: sol.main)
The audio context in which the music will be played. The music stays attached to this context for its whole lifetime: music:play() and music:stop() always use the context it was created with.
music_id (string)
Name of the music file to read, relative to the musics directory and without extension.
Return value (music)
The music object.

Methods of sol.music

music:play()

Starts playing the music.

music:stop()

Stops playing the music.

music:is_paused()

Returns if the music is currently paused.

Return value (boolean)
true if the music is paused.

music:set_paused(paused)

Sets if the music is paused.

paused (boolean)
true to pause the music, false to resume from pause.

music:get_volume()

Returns the volume for this music.

Return value (integer)
The volume between 0 and 100.

music:set_volume(volume)

Sets the volume for this music relative to the global volume (see sol.audio.set_music_volume).

volume (integer)
The volume between 0 and 100.

music:get_channel_volume(channel)

Returns the volume for a specified channel.

Note: this method works only with .it files.

channel (integer)
The channel to retrieve the volume. From 1 to the channel number in IT file.
Return value (integer)
The volume between 0 and 64 (like in your tracker software).

music:set_channel_volume(channel, volume)

Sets the volume for a specified channel.

Note: this method works only with .it files.

channel (integer)
The channel for which the volume will be set. From 1 to the channel number in IT file.
volume (integer)
The volume between 0 and 64 (like in your tracker software).

music:get_channel_pan(channel)

Returns the pan for a specified channel.

Note: this method works only with .it files.

channel (integer)
The channel to retrieve the pan. From 1 to the channel number in IT file.
Return value (integer)
The pan between 0 (left) and 256 (right).

music:set_channel_pan(channel, pan)

Sets the pan for a specified channel.

Note: this method works only with .it files.

channel (integer)
The channel for which the pan will be set. From 1 to the channel number in IT file.
pan (integer)
The pan between 0 (left) and 256 (right).