Веб-сайт самохостера Lotigara

summaryrefslogtreecommitdiff
path: root/doc/lua/openstarbound/songbook.md
blob: 72204f173d40822a694bb3e79d1320beab5e94cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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 `""`.