Document party_gauge.c

include/battle/party_gauge.h

@@ -0,0 +1,105 @@
+#ifndef POKEPLATINUM_BATTLE_PARTY_GAUGE_H
+#define POKEPLATINUM_BATTLE_PARTY_GAUGE_H
+
+#include "struct_decls/struct_02002F38_decl.h"
+#include "struct_decls/struct_0200C6E4_decl.h"
+#include "struct_decls/struct_0200C704_decl.h"
+#include "overlay016/struct_ov16_0226D160_decl.h"
+
+enum PartyGaugeSide {
+    PARTY_GAUGE_OURS,
+    PARTY_GAUGE_THEIRS,
+};
+
+enum ShowPartyGaugeType {
+    SHOW_PARTY_GAUGE_BATTLE_START,
+    SHOW_PARTY_GAUGE_MID_BATTLE,
+};
+
+enum HidePartyGaugeType {
+    HIDE_PARTY_GAUGE_BATTLE_START,
+    HIDE_PARTY_GAUGE_MID_BATTLE,
+};
+
+enum PartyGaugePosition {
+    PARTY_GAUGE_POSITION_HIGH,
+    PARTY_GAUGE_POSITION_MIDDLE,
+    PARTY_GAUGE_POSITION_LOW,
+};
+
+enum HideArrowType {
+    HIDE_ARROW_FADE_AND_SCROLL,
+    HIDE_ARROW_FADE_IN_PLACE,
+};
+
+/**
+ * @brief Load the graphics resources needed for the Party Gauge into memory.
+ * 
+ * @param renderer 
+ * @param gfxHandler 
+ * @param palette 
+ */
+void PartyGauge_LoadGraphics(SpriteRenderer *renderer, SpriteGfxHandler *gfxHandler, PaletteData *palette);
+
+/**
+ * @brief Free the graphics resources needed for the Party Gauge from memory.
+ * 
+ * @param gfxHandler 
+ */
+void PartyGauge_FreeGraphics(SpriteGfxHandler *gfxHandler);
+
+/**
+ * @brief Show the Party Gauge.
+ * 
+ * @param ballStatus    The status of each battler's, represented as a Pokeball with a particular
+ *                      masking filter. Plain Pokeballs represent healthy battlers, gray represent
+ *                      fainted, darkened represent those afflicted with a status condition. For
+ *                      possible values, see enum PartyGaugeBallStatus.
+ * 
+ * @param side          The side of the battle for which the gauge should be displayed.
+ * 
+ * @param showType      How the gauge should be displayed, whether at the start of a battle (a slow
+ *                      inward scroll) or mid-battle after a KO (a faster inward scroll).
+ * 
+ * @param pos           Vertical position of the gauge; only applicable for double battles, so that
+ *                      the gauge does not overlap the HP bar.
+ * @param renderer 
+ * @param gfxHandler 
+ * @return              Pointer to the constructed PartyGauge struct, for tracking its progress
+ *                      and eventually hiding it.
+ */
+PartyGauge* PartyGauge_Show(u8 ballStatus[], enum PartyGaugeSide side, enum ShowPartyGaugeType showType, enum PartyGaugePosition pos, SpriteRenderer *renderer, SpriteGfxHandler *gfxHandler);
+
+/**
+ * @brief Check if the Party Gauge has finished the inward scrolling animation.
+ * 
+ * @param gauge 
+ * @return TRUE if the Party Gauge has finished its animation, else FALSE.
+ */
+BOOL PartyGauge_ShowIsDone(PartyGauge *gauge);
+
+/**
+ * @brief Hide the Party Gauge.
+ * 
+ * @param gauge         Gauge to be hidden.
+ * @param hideArrowType Method by which the arrow element should be hidden.
+ * @param hideGaugeType Method by which the gauge Pokeballs should be hidden.
+ */
+void PartyGauge_Hide(PartyGauge *gauge, enum HideArrowType hideArrowType, enum HidePartyGaugeType hideGaugeType);
+
+/**
+ * @brief Check if the Party Gauge has finished the outward vanishing animation.
+ * 
+ * @param gauge 
+ * @return TRUE if the Party Gauge has finished its animation, else FALSE.
+ */
+BOOL PartyGauge_HideIsDone(PartyGauge *gauge);
+
+/**
+ * @brief Free the Party Gauge and its resources back to the heap.
+ * 
+ * @param gauge 
+ */
+void PartyGauge_Free(PartyGauge *gauge);
+
+#endif // POKEPLATINUM_BATTLE_PARTY_GAUGE_H

include/constants/palette.h

@@ -0,0 +1,47 @@
+#ifndef POKEPLATINUM_CONSTANTS_PALETTE_H
+#define POKEPLATINUM_CONSTANTS_PALETTE_H
+
+enum PaletteBufferId {
+    PLTTBUF_MAIN_BG = 0,
+    PLTTBUF_SUB_BG,
+    PLTTBUF_MAIN_OBJ,
+    PLTTBUF_SUB_OBJ,
+    PLTTBUF_EX_BEGIN,
+
+    PLTTBUF_MAIN_EX_BG_0 = PLTTBUF_EX_BEGIN,
+    PLTTBUF_MAIN_EX_BG_1,
+    PLTTBUF_MAIN_EX_BG_2,
+    PLTTBUF_MAIN_EX_BG_3,
+    PLTTBUF_SUB_EX_BG_0,
+    PLTTBUF_SUB_EX_BG_1,
+    PLTTBUF_SUB_EX_BG_2,
+    PLTTBUF_SUB_EX_BG_3,
+    PLTTBUF_MAIN_EX_OBJ,
+    PLTTBUF_SUB_EX_OBJ,
+
+    PLTTBUF_MAX,
+};
+
+#define PLTTBUF_MAIN_BG_F                      (1<<PLTTBUF_MAIN_BG)
+#define PLTTBUF_SUB_BG_F                       (1<<PLTTBUF_SUB_BG)
+#define PLTTBUF_MAIN_OBJ_F                     (1<<PLTTBUF_MAIN_OBJ)
+#define PLTTBUF_SUB_OBJ_F                      (1<<PLTTBUF_SUB_OBJ)
+#define PLTTBUF_MAIN_EX_BG_0_F                 (1<<PLTTBUF_MAIN_EX_BG_0)
+#define PLTTBUF_MAIN_EX_BG_1_F                 (1<<PLTTBUF_MAIN_EX_BG_1)
+#define PLTTBUF_MAIN_EX_BG_2_F                 (1<<PLTTBUF_MAIN_EX_BG_2)
+#define PLTTBUF_MAIN_EX_BG_3_F                 (1<<PLTTBUF_MAIN_EX_BG_3)
+#define PLTTBUF_SUB_EX_BG_0_F                  (1<<PLTTBUF_SUB_EX_BG_0)
+#define PLTTBUF_SUB_EX_BG_1_F                  (1<<PLTTBUF_SUB_EX_BG_1)
+#define PLTTBUF_SUB_EX_BG_2_F                  (1<<PLTTBUF_SUB_EX_BG_2)
+#define PLTTBUF_SUB_EX_BG_3_F                  (1<<PLTTBUF_SUB_EX_BG_3)
+#define PLTTBUF_MAIN_EX_OBJ_F                  (1<<PLTTBUF_MAIN_EX_OBJ)
+#define PLTTBUF_SUB_EX_OBJ_F                   (1<<PLTTBUF_SUB_EX_OBJ)
+#define PLTTBUF_ALL_F                          ((1<<PLTTBUF_MAX)-1)
+
+enum PaletteSelector {
+    PLTTSEL_TRANSPARENT,
+    PLTTSEL_OPAQUE,
+    PLTTSEL_BOTH,
+};
+
+#endif // POKEPLATINUM_CONSTANTS_PALETTE_H

include/constants/sdat.h

@@ -32,6 +32,10 @@ enum SDATID {
     SEQ_BATTLE_REGI_TRIO,
 
     SEQ_CONFIRM = 1500,
+
+    SEQ_PARTY_GAUGE_ARROW_IN = 1809,
+    SEQ_PARTY_GAUGE_BALL_IN,
+    SEQ_PARTY_GAUGE_BALL_EMPTY,
 };
 
 #endif // POKEPLATINUM_CONSTANTS_SDAT_H

include/overlay005/ov5_021D2F14.h

@@ -7,7 +7,7 @@
 #include "overlay005/struct_ov5_021D30A8.h"
 #include "overlay007/struct_ov7_0224F2EC.h"
 #include "overlay007/struct_ov7_0224F358.h"
-#include "overlay104/struct_ov104_0223F9E0.h"
+#include "struct_defs/sprite_template.h"
 #include "overlay104/struct_ov104_02241308.h"
 
 void ov5_021D2F14(UnkStruct_ov5_021D30A8 * param0, const UnkStruct_ov7_0224F2EC * param1, u32 param2, u32 param3);
@@ -22,7 +22,7 @@ void ov5_021D3388(UnkStruct_ov5_021D30A8 * param0, int param1, int param2, int p
 void ov5_021D339C(UnkStruct_ov5_021D30A8 * param0, NARC * param1, int param2, int param3, int param4);
 void ov5_021D33B0(UnkStruct_ov5_021D30A8 * param0, int param1, int param2, BOOL param3, int param4, int param5);
 void ov5_021D3414(UnkStruct_ov5_021D30A8 * param0, NARC * param1, int param2, BOOL param3, int param4, int param5);
-CellActorData * ov5_021D3584(UnkStruct_ov5_021D30A8 * param0, const UnkStruct_ov104_0223F9E0 * param1);
+CellActorData * ov5_021D3584(UnkStruct_ov5_021D30A8 * param0, const SpriteTemplate * param1);
 void ov5_021D375C(UnkStruct_ov5_021D30A8 * param0);
 
 #endif // POKEPLATINUM_OV5_021D2F14_H

include/overlay011/ov11_0221F800.h

@@ -4,6 +4,6 @@
 #include "struct_decls/struct_02002F38_decl.h"
 
 const u16 * ov11_0221F800(int param0);
-void ov11_0221F81C(PaletteSys * param0, int param1, int param2, int param3, int param4);
+void ov11_0221F81C(PaletteData * param0, int param1, int param2, int param3, int param4);
 
 #endif // POKEPLATINUM_OV11_0221F800_H

include/overlay012/funcptr_ov12_02239E64_1.h

@@ -6,6 +6,6 @@
 #include "struct_decls/struct_02022550_decl.h"
 #include "overlay012/struct_ov12_0221FCDC_decl.h"
 
-typedef void (* UnkFuncPtr_ov12_02239E64_1)(UnkStruct_ov12_0221FCDC *, CellTransferStateData *, AnimationResourceCollection *, GraphicElementData *);
+typedef void (* UnkFuncPtr_ov12_02239E64_1)(UnkStruct_ov12_0221FCDC *, SpriteRenderer *, SpriteGfxHandler *, GraphicElementData *);
 
 #endif // POKEPLATINUM_FUNCPTR_OV12_02239E64_1_H

include/overlay012/funcptr_ov12_02239E68.h

@@ -6,6 +6,6 @@
 #include "struct_decls/cell_actor_data.h"
 #include "overlay012/struct_ov12_0221FCDC_decl.h"
 
-typedef void (* UnkFuncPtr_ov12_02239E68)(UnkStruct_ov12_0221FCDC *, CellTransferStateData *, AnimationResourceCollection *, CellActorData *);
+typedef void (* UnkFuncPtr_ov12_02239E68)(UnkStruct_ov12_0221FCDC *, SpriteRenderer *, SpriteGfxHandler *, CellActorData *);
 
 #endif // POKEPLATINUM_FUNCPTR_OV12_02239E68_H

include/overlay012/ov12_0221FC20.h

@@ -18,7 +18,7 @@
 #include "overlay012/funcptr_ov12_02239EEC.h"
 #include "overlay016/struct_ov16_02264408.h"
 #include "overlay016/struct_ov16_02265BBC.h"
-#include "overlay104/struct_ov104_0223F9E0.h"
+#include "struct_defs/sprite_template.h"
 
 #include "spl.h"
 
@@ -46,9 +46,9 @@ BGL * ov12_02220278(UnkStruct_ov12_0221FCDC * param0);
 s32 ov12_02220280(UnkStruct_ov12_0221FCDC * param0, int param1);
 CellActorData * ov12_02220298(UnkStruct_ov12_0221FCDC * param0, int param1);
 CellActorData * ov12_022202C0(UnkStruct_ov12_0221FCDC * param0, int param1);
-AnimationResourceCollection * ov12_022202EC(UnkStruct_ov12_0221FCDC * param0);
-AnimationResourceCollection * ov12_02220300(UnkStruct_ov12_0221FCDC * param0);
-CellTransferStateData * ov12_02220308(UnkStruct_ov12_0221FCDC * param0);
+SpriteGfxHandler * ov12_022202EC(UnkStruct_ov12_0221FCDC * param0);
+SpriteGfxHandler * ov12_02220300(UnkStruct_ov12_0221FCDC * param0);
+SpriteRenderer * ov12_02220308(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02220474(void);
 int ov12_02220540(UnkStruct_ov12_0221FCDC * param0, int param1);
 void ov12_02220590(UnkStruct_ov12_0221FCDC * param0, UnkStruct_ov12_022380DC * param1, int param2);
@@ -62,14 +62,14 @@ int ov12_02223178(UnkStruct_ov12_02223178 * param0);
 s8 ov12_0222317C(UnkStruct_ov12_0221FCDC * param0, s8 param1);
 s8 ov12_02223234(s8 param0, s8 param1, s8 param2);
 BOOL ov12_0222325C(UnkStruct_ov12_0221FCDC * param0, int param1[], int param2);
-UnkStruct_ov104_0223F9E0 ov12_0222329C(UnkStruct_ov12_0221FCDC * param0);
+SpriteTemplate ov12_0222329C(UnkStruct_ov12_0221FCDC * param0);
 int ov12_022232B8(UnkStruct_ov12_0221FCDC * param0, int param1);
 int ov12_022232C4(UnkStruct_ov12_0221FCDC * param0, int param1);
 int ov12_022232D0(UnkStruct_ov12_0221FCDC * param0, int param1);
 int ov12_022232E0(UnkStruct_ov12_0221FCDC * param0, int param1);
 int ov12_022232EC(UnkStruct_ov12_0221FCDC * param0, int param1);
 Sprite * ov12_022232FC(UnkStruct_ov12_0221FCDC * param0, int param1);
-PaletteSys * ov12_0222332C(UnkStruct_ov12_0221FCDC * param0);
+PaletteData * ov12_0222332C(UnkStruct_ov12_0221FCDC * param0);
 int ov12_02223334(UnkStruct_ov12_0221FCDC * param0, int param1);
 int ov12_02223344(UnkStruct_ov12_0221FCDC * param0, int param1);
 int ov12_02223354(UnkStruct_ov12_0221FCDC * param0, int param1);

include/overlay012/ov12_02225864.h

@@ -79,7 +79,7 @@ void ov12_0222676C(s16 param0, s16 param1, s16 param2, s16 param3, u16 * param4)
 BOOL ov12_022267A8(int * param0, int param1, s32 param2);
 BOOL ov12_02226848(UnkStruct_ov12_022267D4 * param0);
 void ov12_02226858(UnkStruct_ov12_022267D4 * param0);
-UnkStruct_ov12_022267D4 * ov12_02226870(PaletteSys * param0, int param1, int param2, u16 param3, u16 param4, s8 param5, s8 param6, u8 param7, u8 param8, u16 param9, int param10);
+UnkStruct_ov12_022267D4 * ov12_02226870(PaletteData * param0, int param1, int param2, u16 param3, u16 param4, s8 param5, s8 param6, u8 param7, u8 param8, u16 param9, int param10);
 void ov12_02226924(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02226954(UnkStruct_ov12_0221FCDC * param0);
 

include/overlay012/ov12_022269C0.h

@@ -10,6 +10,6 @@ void ov12_022269C0(UnkStruct_ov12_0221FCDC * param0);
 void ov12_022269EC(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02226A3C(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02226A88(UnkStruct_ov12_0221FCDC * param0);
-void ov12_02226B1C(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_02226B1C(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 
 #endif // POKEPLATINUM_OV12_022269C0_H

include/overlay012/ov12_02226B84.h

@@ -11,7 +11,7 @@ void ov12_02226EB0(UnkStruct_ov12_0221FCDC * param0);
 void ov12_022271D8(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02227408(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02227534(UnkStruct_ov12_0221FCDC * param0);
-void ov12_0222777C(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222777C(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 void ov12_02227828(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222797C(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02227CBC(UnkStruct_ov12_0221FCDC * param0);
@@ -38,10 +38,10 @@ void ov12_02229B28(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02229C5C(UnkStruct_ov12_0221FCDC * param0);
 void ov12_02229E54(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222A00C(UnkStruct_ov12_0221FCDC * param0);
-void ov12_0222A1AC(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
-void ov12_0222A34C(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
-void ov12_0222A410(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
-void ov12_0222A5C0(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222A1AC(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
+void ov12_0222A34C(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
+void ov12_0222A410(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
+void ov12_0222A5C0(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 void ov12_0222A604(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222A8F4(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222AB50(UnkStruct_ov12_0221FCDC * param0);

include/overlay012/ov12_0222AC70.h

@@ -6,7 +6,7 @@
 #include "struct_decls/cell_actor_data.h"
 #include "overlay012/struct_ov12_0221FCDC_decl.h"
 
-void ov12_0222AE68(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222AE68(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 void ov12_0222B194(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222B45C(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222B68C(UnkStruct_ov12_0221FCDC * param0);
@@ -22,8 +22,8 @@ void ov12_0222C6D4(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222C8F8(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222CA2C(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222CB90(UnkStruct_ov12_0221FCDC * param0);
-void ov12_0222CC54(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222CC54(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 void ov12_0222CFA0(UnkStruct_ov12_0221FCDC * param0);
-void ov12_0222D56C(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222D56C(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 
 #endif // POKEPLATINUM_OV12_0222AC70_H

include/overlay012/ov12_0222D6B0.h

@@ -6,12 +6,12 @@
 #include "struct_decls/cell_actor_data.h"
 #include "overlay012/struct_ov12_0221FCDC_decl.h"
 
-void ov12_0222D7C0(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
-void ov12_0222DB60(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
-void ov12_0222DEFC(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222D7C0(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
+void ov12_0222DB60(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
+void ov12_0222DEFC(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 void ov12_0222E1A8(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222E248(CellActorData * param0);
-void ov12_0222E2F8(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
-void ov12_0222E61C(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222E2F8(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
+void ov12_0222E61C(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 
 #endif // POKEPLATINUM_OV12_0222D6B0_H

include/overlay012/ov12_0222E91C.h

@@ -7,7 +7,7 @@
 #include "overlay012/struct_ov12_0221FCDC_decl.h"
 
 void ov12_0222EAA0(UnkStruct_ov12_0221FCDC * param0);
-void ov12_0222EC90(UnkStruct_ov12_0221FCDC * param0, CellTransferStateData * param1, AnimationResourceCollection * param2, CellActorData * param3);
+void ov12_0222EC90(UnkStruct_ov12_0221FCDC * param0, SpriteRenderer * param1, SpriteGfxHandler * param2, CellActorData * param3);
 void ov12_0222EFB0(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222F2F8(UnkStruct_ov12_0221FCDC * param0);
 void ov12_0222F5EC(UnkStruct_ov12_0221FCDC * param0);