Name
PlaySubsong -- play subsong of music object
Synopsis
PlaySubsong(number[, id, table])
Function
This command can be used to play the specified subsong of a music object. If you omit the optional argument id the currently playing music is used.

The optional table argument can be used to specify further options. This table argument supports the same fields like the PlayMusic() command. See PlayMusic for details.

Please note that only some music formats support subsongs. For example, old tracker module formats can often contain multiple subsongs. If a Protracker module is used, this command will jump to the specified song position.

Inputs
number
number of subsong to play
id
optional: identifier of the music object to use (defaults to currently playing music) (V5.3)
table
optional: table argument specifying further options (V5.3)
Example
PlaySubsong(5, 1)
The above code starts playing Protracker module number 1, starting at song position 5.
Show TOC