Document Poketch Kitchen Timer (Overlay 46) (#810)

Author: VicSevenT

include/applications/poketch/kitchen_timer/graphics.h

@@ -0,0 +1,74 @@
+#ifndef POKEPLATINUM_POKETCH_KITCHEN_TIMER_GRAPHICS_H
+#define POKEPLATINUM_POKETCH_KITCHEN_TIMER_GRAPHICS_H
+
+#include "applications/poketch/poketch_animation.h"
+#include "applications/poketch/poketch_task.h"
+
+#include "bg_window.h"
+
+#define KITCHEN_TIMER_TASK_SLOTS 8
+
+#define NUM_STATE_BUTTONS 3
+
+#define NUM_SPRITES               17
+#define SPRITE_HAND_LEFT          0
+#define SPRITE_HAND_RIGHT         1
+#define SPRITE_START_BUTTON       2
+#define SPRITE_STOP_BUTTON        3
+#define SPRITE_RESET_BUTTON       4
+#define SPRITE_MINUTES_TENS_UP    5
+#define SPRITE_MINUTES_ONES_UP    6
+#define SPRITE_SECONDS_TENS_UP    7
+#define SPRITE_SECONDS_ONES_UP    8
+#define SPRITE_MINUTES_TENS_DOWN  9
+#define SPRITE_MINUTES_ONES_DOWN  10
+#define SPRITE_SECONDS_TENS_DOWN  11
+#define SPRITE_SECONDS_ONES_DOWN  12
+#define SPRITE_MINUTES_TENS_DIGIT 13
+#define SPRITE_MINUTES_ONES_DIGIT 14
+#define SPRITE_SECONDS_TENS_DIGIT 15
+#define SPRITE_SECONDS_ONES_DIGIT 16
+
+typedef struct KitchenTimerDisplay {
+    s8 minutesTensDigit;
+    s8 minutesOnesDigit;
+    s8 secondsTensDigit;
+    s8 secondsOnesDigit;
+    u8 buttonPressed[NUM_STATE_BUTTONS];
+    BOOL editingActive;
+    u32 handPositions;
+    u32 beatingHandPosition;
+} KitchenTimerDisplay;
+
+typedef struct KitchenTimerGraphics {
+    const KitchenTimerDisplay *timerData;
+    BgConfig *bgConfig;
+    u32 activeTasks[POKETCH_TASK_SLOT_BASE + KITCHEN_TIMER_TASK_SLOTS];
+    PoketchAnimation_AnimationManager *animMan;
+    PoketchAnimation_AnimatedSpriteData *sprites[NUM_SPRITES];
+    PoketchAnimation_SpriteData timerSpritesData;
+    PoketchAnimation_SpriteData digitSpritesData;
+    BOOL stopBeatingHands;
+    u32 beatingHandTimer;
+    u32 beatingHandPositions;
+} KitchenTimerGraphics;
+
+enum KitchenTimerGraphicsTask {
+    KITCHEN_TIMER_GRAPHICS_INIT = 0,
+    KITCHEN_TIMER_GRAPHICS_FREE,
+    KITCHEN_TIMER_GRAPHICS_RESET_TIMER,
+    KITCHEN_TIMER_GRAPHICS_START_TIMER,
+    KITCHEN_TIMER_GRAPHICS_UPDATE_BUTTONS,
+    KITCHEN_TIMER_GRAPHICS_UPDATE_DIGITS,
+    KITCHEN_TIMER_GRAPHICS_BEAT_HANDS,
+    KITCHEN_TIMER_GRAPHICS_STOP_HANDS,
+};
+
+BOOL PoketchKitchenTimerGraphics_New(KitchenTimerGraphics **dest, const KitchenTimerDisplay *timerData, BgConfig *bgConfig);
+void PoketchKitchenTimerGraphics_Free(KitchenTimerGraphics *graphics);
+void PoketchKitchenTimerGraphics_StartTask(KitchenTimerGraphics *graphics, enum KitchenTimerGraphicsTask taskID);
+BOOL PoketchKitchenTimerGraphics_TaskIsNotActive(KitchenTimerGraphics *graphics, enum KitchenTimerGraphicsTask taskID);
+BOOL PoketchKitchenTimerGraphics_NoActiveTasks(KitchenTimerGraphics *graphics);
+u32 PoketchKitchenTimerGraphics_GetBeatingHandsPosition(KitchenTimerGraphics *graphics);
+
+#endif // POKEPLATINUM_POKETCH_KITCHEN_TIMER_GRAPHICS_H

include/overlay046/ov46_02256BCC.h

@@ -1019,11 +1019,11 @@ Overlay poketch_alarm_clock
 	Object main.nef.p/src_applications_poketch_alarm_clock_graphics.c.o
 }
 
-Overlay overlay46
+Overlay poketch_kitchen_timer
 {
 	After overlay25
-	Object main.nef.p/src_overlay046_ov46_022561C0.c.o
-	Object main.nef.p/src_overlay046_ov46_02256BCC.c.o
+	Object main.nef.p/src_applications_poketch_kitchen_timer_main.c.o
+	Object main.nef.p/src_applications_poketch_kitchen_timer_graphics.c.o
 }
 
 Overlay poketch_marking_map

include/overlay046/struct_ov46_02256BCC_1.h

@@ -45,7 +45,7 @@ ba5baba0ff38e940d333dbea89e4c510b6998922 *poketch_coin_toss.sbin
 261b64d5fd09a304a5d7e78a18b44a6ecfe7ec93 *poketch_move_tester.sbin
 5dd962600f238f162c0999dcb8a134c9df134293 *poketch_matchup_checker.sbin
 e722ce81a98e1d78011e179f008a4cac37e20610 *poketch_alarm_clock.sbin
-87cd3ac2574737177d399a8cf8a8374c9599e38b *overlay46.sbin
+87cd3ac2574737177d399a8cf8a8374c9599e38b *poketch_kitchen_timer.sbin
 b38da9fe733a6a1213ff217f4e2788e3ae2011a4 *poketch_marking_map.sbin
 70266035d948ee5a826b06a3a1b908a50af050c9 *overlay48.sbin
 489ae29169ae71eb72909fdebdd0aa8bf8ca63f4 *poketch_color_changer.sbin