diff options
-rw-r--r-- | doc/lua/openstarbound/songbook.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/lua/openstarbound/songbook.md b/doc/lua/openstarbound/songbook.md new file mode 100644 index 0000000..72204f1 --- /dev/null +++ b/doc/lua/openstarbound/songbook.md @@ -0,0 +1,51 @@ +# Songbook + +The new songbook table is accessible from players and NPC's. + +--- + +#### `String` songbook.band() + +Returns a string containing the instrumentalist's current band. Defaults to `""`. + +--- + +#### `song` songbook.song() + +Returns the notes of the song currently being played. + +--- + +#### `?` songbook.keepAlive(`?` ?) + +todo + +--- + +#### `void` songbook.stop() + +Causes the instrumentalist to stop playing. + +--- + +#### `bool` songbook.active() + +Returns whether the instrumentalist is playing a song. + +--- + +#### `bool` songbook.instrumentPlaying() + +Returns whether the instrumentalist is currently performing part of a song. + +--- + +#### `void` songbook.play(`?` ?) + +todo + +--- + +#### `String` songbook.instrument() + +Returns the type of instrument last played, as determined by the instrument's `kind` value. Defaults to `""`. |