docs for table properties

inc/init/init.minigame.lua

@@ -111,7 +111,32 @@ end
 
 --- Configures DDR minigame.
 --- @within Minigame
--- @param params table Optional parameters to override defaults.
+-- @param params table Optional parameters to override defaults (see Minigame.get_default_ddr).
+-- @param[opt] params.bar_fill number Current fill level of the progress bar.
+-- @param[opt] params.max_fill number Maximum fill value to win.
+-- @param[opt] params.fill_per_hit number Fill gained per successful hit.
+-- @param[opt] params.miss_penalty number Fill lost per miss.
+-- @param[opt] params.bar_x number Progress bar X position.
+-- @param[opt] params.bar_y number Progress bar Y position.
+-- @param[opt] params.bar_width number Progress bar width.
+-- @param[opt] params.bar_height number Progress bar height.
+-- @param[opt] params.arrow_size number Size of arrow sprites.
+-- @param[opt] params.arrow_spawn_timer number Timer for arrow spawning.
+-- @param[opt] params.arrow_spawn_interval number Frames between arrow spawns.
+-- @param[opt] params.arrow_fall_speed number Speed of falling arrows.
+-- @param[opt] params.arrows table Array of active arrow objects.
+-- @param[opt] params.target_y number Y position of the target line.
+-- @param[opt] params.target_arrows table Array of target arrow positions with dir and x fields.
+-- @param[opt] params.hit_threshold number Pixel distance for a valid hit.
+-- @param[opt] params.button_pressed_timers table Per-button press animation timers.
+-- @param[opt] params.button_press_duration number Duration of button press animation.
+-- @param[opt] params.input_cooldowns table Per-direction cooldown timers (left, down, up, right).
+-- @param[opt] params.input_cooldown_duration number Frames of input cooldown.
+-- @param[opt] params.frame_counter number Global frame counter.
+-- @param[opt] params.current_song table Currently playing song data.
+-- @param[opt] params.pattern_index number Current index in song pattern.
+-- @param[opt] params.use_pattern boolean Whether to use song pattern for spawning.
+-- @param[opt] params.return_window string Window ID to return to after minigame.
 -- @return table The configured DDR minigame state.
 function Minigame.configure_ddr(params)
   return apply_params(Minigame.get_default_ddr(), params)
@@ -119,7 +144,22 @@ end
 
 --- Configures button mash minigame.
 --- @within Minigame
--- @param params table Optional parameters to override defaults.
+-- @param params table Optional parameters to override defaults (see Minigame.get_default_button_mash).
+-- @param[opt] params.bar_fill number Current fill level of the progress bar.
+-- @param[opt] params.max_fill number Maximum fill value to win.
+-- @param[opt] params.fill_per_press number Fill gained per button press.
+-- @param[opt] params.base_degradation number Base rate of bar degradation per frame.
+-- @param[opt] params.degradation_multiplier number Multiplier for degradation scaling.
+-- @param[opt] params.button_pressed_timer number Button press animation timer.
+-- @param[opt] params.button_press_duration number Duration of button press animation.
+-- @param[opt] params.return_window string Window ID to return to after minigame.
+-- @param[opt] params.bar_x number Progress bar X position.
+-- @param[opt] params.bar_y number Progress bar Y position.
+-- @param[opt] params.bar_width number Progress bar width.
+-- @param[opt] params.bar_height number Progress bar height.
+-- @param[opt] params.button_x number Button indicator X position.
+-- @param[opt] params.button_y number Button indicator Y position.
+-- @param[opt] params.button_size number Button indicator size.
 -- @return table The configured button mash minigame state.
 function Minigame.configure_button_mash(params)
   return apply_params(Minigame.get_default_button_mash(), params)
@@ -127,7 +167,29 @@ end
 
 --- Configures rhythm minigame.
 --- @within Minigame
--- @param params table Optional parameters to override defaults.
+-- @param params table Optional parameters to override defaults (see Minigame.get_default_rhythm).
+-- @param[opt] params.line_position number Current position of the moving line (0-1).
+-- @param[opt] params.line_speed number Speed of the moving line per frame.
+-- @param[opt] params.line_direction number Direction of line movement (1 or -1).
+-- @param[opt] params.target_center number Center of the target zone (0-1).
+-- @param[opt] params.target_width number Current width of the target zone.
+-- @param[opt] params.initial_target_width number Starting width of the target zone.
+-- @param[opt] params.min_target_width number Minimum width the target zone can shrink to.
+-- @param[opt] params.target_shrink_rate number Multiplier applied to target width after each hit.
+-- @param[opt] params.score number Current score.
+-- @param[opt] params.max_score number Score needed to win.
+-- @param[opt] params.button_pressed_timer number Button press animation timer.
+-- @param[opt] params.button_press_duration number Duration of button press animation.
+-- @param[opt] params.return_window string Window ID to return to after minigame.
+-- @param[opt] params.bar_x number Progress bar X position.
+-- @param[opt] params.bar_y number Progress bar Y position.
+-- @param[opt] params.bar_width number Progress bar width.
+-- @param[opt] params.bar_height number Progress bar height.
+-- @param[opt] params.button_x number Button indicator X position.
+-- @param[opt] params.button_y number Button indicator Y position.
+-- @param[opt] params.button_size number Button indicator size.
+-- @param[opt] params.press_cooldown number Current cooldown timer.
+-- @param[opt] params.press_cooldown_duration number Frames of press cooldown.
 -- @return table The configured rhythm minigame state.
 function Minigame.configure_rhythm(params)
   return apply_params(Minigame.get_default_rhythm(), params)