From fb8b0e877ebae163c1a55ccfe8c7cb150d7f1d9b Mon Sep 17 00:00:00 2001 From: AFCMS Date: Fri, 12 Mar 2021 00:24:34 +0100 Subject: [PATCH] Add API documentation for mcl_jukeboxe --- mods/ITEMS/mcl_jukebox/API.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 mods/ITEMS/mcl_jukebox/API.md diff --git a/mods/ITEMS/mcl_jukebox/API.md b/mods/ITEMS/mcl_jukebox/API.md new file mode 100644 index 000000000..85900ede0 --- /dev/null +++ b/mods/ITEMS/mcl_jukebox/API.md @@ -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 \ No newline at end of file