Add API documentation for mcl_jukeboxe

This commit is contained in:
AFCMS 2021-03-12 00:24:34 +01:00 committed by Nils Dagsson Moskopp
parent b6fc888559
commit 20b7b6ff99
No known key found for this signature in database
GPG Key ID: A3BC671C35191080
1 changed files with 18 additions and 0 deletions

View File

@ -0,0 +1,18 @@
# mcl_jukebox
## mcl_jukebox.register_record(title, author, identifier, image, sound)
* title: title of the track
* author: author of the track
* identifier: short string used in the item registration
* image: the texture of the track
* sound: sound file of the track
## mcl_jukebox.registered_records
Table indexed by item name containing:
* title: title of the track
* author: author of the track
* identifier: short string used in the item registration
* image: the texture of the track
* sound: sound file of the track