section and within annotations for ldoc
This commit is contained in:
@@ -1,28 +1,43 @@
|
||||
--- @section Audio
|
||||
|
||||
--- Stops current music.
|
||||
--- @within Audio
|
||||
function Audio.music_stop() music() end
|
||||
--- Plays main menu music.
|
||||
--- @within Audio
|
||||
function Audio.music_play_mainmenu() end
|
||||
--- Plays waking up music.
|
||||
--- @within Audio
|
||||
function Audio.music_play_wakingup() end
|
||||
--- Plays room morning music.
|
||||
--- @within Audio
|
||||
function Audio.music_play_room_morning() end
|
||||
--- Plays room street 1 music.
|
||||
--- @within Audio
|
||||
function Audio.music_play_room_street_1() end
|
||||
--- Plays room street 2 music.
|
||||
--- @within Audio
|
||||
function Audio.music_play_room_street_2() end
|
||||
--- Plays room music.
|
||||
-- TODO: function name is incomplete, determine the correct room identifier
|
||||
--- @within Audio
|
||||
function Audio.music_play_room_() end
|
||||
--- Plays room work music.
|
||||
--- @within Audio
|
||||
function Audio.music_play_room_work() end
|
||||
|
||||
--- Plays select sound effect.
|
||||
--- @within Audio
|
||||
function Audio.sfx_select() sfx(17, 'C-7', 30) end
|
||||
--- Plays deselect sound effect.
|
||||
--- @within Audio
|
||||
function Audio.sfx_deselect() sfx(18, 'C-7', 30) end
|
||||
--- Plays beep sound effect.
|
||||
--- @within Audio
|
||||
function Audio.sfx_beep() sfx(19, 'C-6', 30) end
|
||||
--- Plays success sound effect.
|
||||
--- @within Audio
|
||||
function Audio.sfx_success() sfx(16, 'C-7', 60) end
|
||||
--- Plays bloop sound effect.
|
||||
--- @within Audio
|
||||
function Audio.sfx_bloop() sfx(21, 'C-3', 60) end
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
--- @section Songs
|
||||
|
||||
-- DDR Arrow Spawn Patterns
|
||||
-- Each song defines when arrows should spawn, synced to music beats
|
||||
|
||||
Songs = {
|
||||
-- Example song pattern
|
||||
test_song = {
|
||||
@@ -108,6 +109,7 @@ Songs = {
|
||||
}
|
||||
|
||||
--- Converts beats to frames.
|
||||
--- @within Songs
|
||||
-- @param beat number The beat number.
|
||||
-- @param bpm number Beats per minute.
|
||||
-- @param[opt] fps number Frames per second (default: 60).
|
||||
@@ -120,6 +122,7 @@ function frame_from_beat(beat, bpm, fps)
|
||||
end
|
||||
|
||||
--- Converts beat notation to frame pattern.
|
||||
--- @within Songs
|
||||
-- @param beats table A table of beat data, e.g., {{1, "left"}, {2, "down"}}.
|
||||
-- @param bpm number Beats per minute.
|
||||
-- @param[opt] fps number Frames per second (default: 60).
|
||||
|
||||
Reference in New Issue
Block a user