Merge pull request #367 from lhearachel/sprite-system

Document sprite_system.c + update sprite terminology
pret · Feb 14, 2025 · 1627401 · 1627401
2 parents afb4fdf + ec5eede
commit 1627401
Show file tree

Hide file tree

Showing 526 changed files with 12,580 additions and 13,197 deletions.
diff --git a/include/applications/pokemon_summary_screen/main.h b/include/applications/pokemon_summary_screen/main.h
@@ -5,24 +5,22 @@
 
 #include "constants/moves.h"
 
-#include "struct_decls/cell_actor_data.h"
 #include "struct_decls/pokemon_animation_sys_decl.h"
-#include "struct_decls/sprite_decl.h"
 #include "struct_decls/struct_0200C440_decl.h"
-#include "struct_decls/struct_0200C6E4_decl.h"
-#include "struct_decls/struct_0200C704_decl.h"
 #include "struct_defs/archived_poke_sprite_data.h"
 #include "struct_defs/chatot_cry.h"
+#include "struct_defs/pokemon_sprite.h"
 #include "struct_defs/sprite_animation_frame.h"
 
 #include "bg_window.h"
 #include "camera.h"
-#include "cell_actor.h"
 #include "game_options.h"
 #include "message.h"
 #include "narc.h"
 #include "pokemon.h"
 #include "savedata.h"
+#include "sprite.h"
+#include "sprite_system.h"
 #include "strbuf.h"
 #include "string_template.h"
 #include "text.h"
@@ -403,7 +401,7 @@ typedef struct PokemonSummaryMonSpriteData {
     void *spriteManager;
     SpriteAnimationFrame frames[MAX_ANIMATION_FRAMES];
     PokemonAnimationSys *animationSys;
-    Sprite *sprite;
+    PokemonSprite *sprite;
     BOOL flip;
 } PokemonSummaryMonSpriteData;
 
@@ -422,10 +420,10 @@ typedef struct PokemonSummaryScreen {
     ConditionRectangle maxRects[MAX_CONDITION_RECT];
     u32 conditionState;
 
-    SpriteRenderer *renderer;
-    SpriteGfxHandler *gfxHandler;
-    CellActor *sprites[SUMMARY_SPRITE_MAX];
-    CellActorData *actor[SUMMARY_SPRITE_MAX];
+    SpriteSystem *spriteSys;
+    SpriteManager *spriteMan;
+    Sprite *sprites[SUMMARY_SPRITE_MAX];
+    ManagedSprite *managedSprites[SUMMARY_SPRITE_MAX];
 
     UnkStruct_0200C440 *unk_684;
     MessageLoader *msgLoader;

diff --git a/...lications/pokemon_summary_screen/sprite.h → ...ications/pokemon_summary_screen/sprites.h b/...lications/pokemon_summary_screen/sprite.h → ...ications/pokemon_summary_screen/sprites.h
@@ -1,5 +1,5 @@
-#ifndef POKEPLATINUM_POKEMON_SUMMARY_SCREEN_SPRITE_H
-#define POKEPLATINUM_POKEMON_SUMMARY_SCREEN_SPRITE_H
+#ifndef POKEPLATINUM_POKEMON_SUMMARY_SCREEN_SPRITES_H
+#define POKEPLATINUM_POKEMON_SUMMARY_SCREEN_SPRITES_H
 
 #include "applications/pokemon_summary_screen/main.h"
 
@@ -38,4 +38,4 @@ void PokemonSummaryScreen_UpdateRibbonFlashAnim(PokemonSummaryScreen *summaryScr
 void PokemonSummaryScreen_UpdateConditionFlashSprites(PokemonSummaryScreen *summaryScreen, BOOL showFlashes);
 void PokemonSummaryScreen_UpdateConditionFlashAnim(PokemonSummaryScreen *summaryScreen);
 
-#endif // POKEPLATINUM_POKEMON_SUMMARY_SCREEN_SPRITE_H
+#endif // POKEPLATINUM_POKEMON_SUMMARY_SCREEN_SPRITES_H
diff --git a/include/battle/battle_context.h b/include/battle/battle_context.h
@@ -5,7 +5,6 @@
 #include "constants/pokemon.h"
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/cell_actor_data.h"
 #include "struct_decls/font_oam.h"
 
 #include "battle/ai_context.h"
@@ -14,6 +13,7 @@
 #include "overlay012/struct_ball_rotation_decl.h"
 
 #include "char_transfer.h"
+#include "sprite_system.h"
 
 typedef struct BattleContext BattleContext;
 
@@ -107,7 +107,7 @@ typedef struct BattleScriptTaskData {
     BattleSystem *battleSys;
     BattleContext *battleCtx;
     BallRotation *ballRotation;
-    CellActorData *cellActorData[2];
+    ManagedSprite *sprites[2];
     FontOAM *fontOAM;
     CharTransferAllocation charTransferAllocation;
     int flag;

diff --git a/include/battle/battle_display.h b/include/battle/battle_display.h
@@ -2,8 +2,8 @@
 #define POKEPLATINUM_OV16_0225CBB8_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
 #include "struct_defs/battle_io.h"
+#include "struct_defs/pokemon_sprite.h"
 
 #include "battle/battle_message.h"
 #include "battle/struct_ov16_0225BFFC_decl.h"
@@ -153,7 +153,7 @@ void ov16_0225E4C8(BattleSystem *param0, BattlerData *param1, UnkStruct_ov16_022
 void ov16_02263730(BattleSystem *param0, BattlerData *param1);
 u8 Battler_Type(BattlerData *param0);
 u8 Battler_BootState(BattlerData *param0);
-Sprite *ov16_02263AFC(BattlerData *param0);
+PokemonSprite *ov16_02263AFC(BattlerData *param0);
 Healthbar *ov16_02263B08(BattlerData *param0);
 UnkStruct_ov16_0226C378 *ov16_02263B0C(BattlerData *param0);
 void ov16_02263B10(BattlerData *param0);

diff --git a/include/battle/healthbar.h b/include/battle/healthbar.h
@@ -1,14 +1,11 @@
 #ifndef POKEPLATINUM_OV16_02266F1C_H
 #define POKEPLATINUM_OV16_02266F1C_H
 
-#include "struct_decls/cell_actor_data.h"
-#include "struct_decls/struct_0200C6E4_decl.h"
-#include "struct_decls/struct_0200C704_decl.h"
-
 #include "battle/struct_ov16_022674C4.h"
 
 #include "narc.h"
 #include "palette.h"
+#include "sprite_system.h"
 
 #define HEALTHBAR_INFO_NONE                   0
 #define HEALTHBAR_INFO_HP_GAUGE               (1 << 0)
@@ -65,8 +62,8 @@ enum HealthbarGaugeType {
  * @param palette
  * @param healthbarType
  */
-void Healthbar_LoadResources(SpriteRenderer *renderer, SpriteGfxHandler *gfxHandler, NARC *narc, PaletteData *palette, enum HealthbarType healthbarType);
-CellActorData *Healthbar_LoadCellActor(SpriteRenderer *renderer, SpriteGfxHandler *handler, int type);
+void Healthbar_LoadResources(SpriteSystem *spriteSys, SpriteManager *spriteMan, NARC *narc, PaletteData *palette, enum HealthbarType healthbarType);
+ManagedSprite *Healthbar_DrawSprite(SpriteSystem *spriteSys, SpriteManager *spriteMan, int type);
 
 /**
  * @brief Draw the informational parts of the healthbar, according to a set

diff --git a/include/battle/ov16_0223DF00.h b/include/battle/ov16_0223DF00.h
@@ -6,13 +6,11 @@
 #include "struct_decls/battle_system.h"
 #include "struct_decls/pokedexdata_decl.h"
 #include "struct_decls/pokemon_animation_sys_decl.h"
-#include "struct_decls/sprite_decl.h"
 #include "struct_decls/struct_02007768_decl.h"
 #include "struct_decls/struct_0200C440_decl.h"
-#include "struct_decls/struct_0200C6E4_decl.h"
-#include "struct_decls/struct_0200C704_decl.h"
 #include "struct_decls/struct_020797DC_decl.h"
 #include "struct_defs/chatot_cry.h"
+#include "struct_defs/pokemon_sprite.h"
 #include "struct_defs/trainer.h"
 
 #include "battle/battle_context.h"
@@ -33,6 +31,7 @@
 #include "palette.h"
 #include "party.h"
 #include "pokemon.h"
+#include "sprite_system.h"
 #include "strbuf.h"
 #include "string_template.h"
 #include "trainer_info.h"
@@ -86,8 +85,8 @@ int BattleSystem_PartyCount(BattleSystem *battleSys, int battler);
 Pokemon *BattleSystem_PartyPokemon(BattleSystem *battleSys, int battler, int slot);
 UnkStruct_02007768 *ov16_0223E000(BattleSystem *battleSys);
 UnkStruct_ov12_0221FCDC *ov16_0223E008(BattleSystem *battleSys);
-SpriteRenderer *ov16_0223E010(BattleSystem *battleSys);
-SpriteGfxHandler *ov16_0223E018(BattleSystem *battleSys);
+SpriteSystem *ov16_0223E010(BattleSystem *battleSys);
+SpriteManager *ov16_0223E018(BattleSystem *battleSys);
 UnkStruct_ov16_02268520 *ov16_0223E020(BattleSystem *battleSys, int param1);
 UnkStruct_ov16_02268A14 *ov16_0223E02C(BattleSystem *battleSys);
 PartyGauge *ov16_0223E034(BattleSystem *battleSys, enum PartyGaugeSide param1);
@@ -271,7 +270,7 @@ void BattleSystem_ShowStopPlaybackButton(BattleSystem *battleSys);
 u8 BattleSystem_RecordedChatter(BattleSystem *battleSys, int param1);
 void ov16_0223F858(BattleSystem *battleSys, u8 *param1);
 void ov16_0223F87C(BattleSystem *battleSys, u8 *param1);
-void ov16_0223F8AC(BattleSystem *battleSys, Sprite **param1);
+void ov16_0223F8AC(BattleSystem *battleSys, PokemonSprite **param1);
 void BattleSystem_SetGaugePriority(BattleSystem *battleSys, int param1);
 
 /**

diff --git a/include/battle/ov16_0226DB7C.h b/include/battle/ov16_0226DB7C.h
@@ -1,16 +1,14 @@
 #ifndef POKEPLATINUM_OV16_0226DB7C_H
 #define POKEPLATINUM_OV16_0226DB7C_H
 
-#include "struct_decls/struct_0200C6E4_decl.h"
-#include "struct_decls/struct_0200C704_decl.h"
-
 #include "battle/struct_ov16_0226DC24_decl.h"
 
 #include "palette.h"
+#include "sprite_system.h"
 
-void ov16_0226DB7C(SpriteRenderer *param0, SpriteGfxHandler *param1, PaletteData *param2, int param3, u32 param4, u32 param5, u32 param6, u32 param7);
-void ov16_0226DBFC(SpriteGfxHandler *param0, u32 param1, u32 param2, u32 param3, u32 param4);
-UnkStruct_ov16_0226DC24 *ov16_0226DC24(SpriteRenderer *param0, SpriteGfxHandler *param1, int param2, u32 param3, u32 param4, u32 param5, u32 param6, u32 param7, u32 param8);
+void ov16_0226DB7C(SpriteSystem *param0, SpriteManager *param1, PaletteData *param2, int param3, u32 param4, u32 param5, u32 param6, u32 param7);
+void ov16_0226DBFC(SpriteManager *param0, u32 param1, u32 param2, u32 param3, u32 param4);
+UnkStruct_ov16_0226DC24 *ov16_0226DC24(SpriteSystem *param0, SpriteManager *param1, int param2, u32 param3, u32 param4, u32 param5, u32 param6, u32 param7, u32 param8);
 void ov16_0226DCA8(UnkStruct_ov16_0226DC24 *param0);
 void ov16_0226DCCC(UnkStruct_ov16_0226DC24 *param0, int param1, int param2, int param3, int param4, int param5, int param6, int param7, int param8, fx32 param9);
 void ov16_0226DD54(UnkStruct_ov16_0226DC24 *param0, int param1, int param2, int param3, int param4, int param5, int param6, int param7, int param8);

diff --git a/include/battle/ov16_0226DE44.h b/include/battle/ov16_0226DE44.h
@@ -1,16 +1,14 @@
 #ifndef POKEPLATINUM_OV16_0226DE44_H
 #define POKEPLATINUM_OV16_0226DE44_H
 
-#include "struct_decls/struct_0200C6E4_decl.h"
-#include "struct_decls/struct_0200C704_decl.h"
-
 #include "battle/struct_ov16_0226DEEC_decl.h"
 
 #include "palette.h"
+#include "sprite_system.h"
 
-void ov16_0226DE44(SpriteRenderer *param0, SpriteGfxHandler *param1, u32 param2, PaletteData *param3, u32 param4, u32 param5, u32 param6, u32 param7);
-void ov16_0226DEC4(SpriteGfxHandler *param0, u32 param1, u32 param2, u32 param3, u32 param4);
-UnkStruct_ov16_0226DEEC *ov16_0226DEEC(SpriteRenderer *param0, SpriteGfxHandler *param1, int param2, u32 param3, u32 param4, u32 param5, u32 param6, u32 param7, u32 param8);
+void ov16_0226DE44(SpriteSystem *param0, SpriteManager *param1, u32 param2, PaletteData *param3, u32 param4, u32 param5, u32 param6, u32 param7);
+void ov16_0226DEC4(SpriteManager *param0, u32 param1, u32 param2, u32 param3, u32 param4);
+UnkStruct_ov16_0226DEEC *ov16_0226DEEC(SpriteSystem *param0, SpriteManager *param1, int param2, u32 param3, u32 param4, u32 param5, u32 param6, u32 param7, u32 param8);
 void ov16_0226DF68(UnkStruct_ov16_0226DEEC *param0);
 void ov16_0226DF80(UnkStruct_ov16_0226DEEC *param0, int param1, int param2, fx32 param3);
 void ov16_0226DFB0(UnkStruct_ov16_0226DEEC *param0, int param1, int param2);

diff --git a/include/battle/party_gauge.h b/include/battle/party_gauge.h
@@ -1,12 +1,10 @@
 #ifndef POKEPLATINUM_BATTLE_PARTY_GAUGE_H
 #define POKEPLATINUM_BATTLE_PARTY_GAUGE_H
 
-#include "struct_decls/struct_0200C6E4_decl.h"
-#include "struct_decls/struct_0200C704_decl.h"
-
 #include "battle/struct_ov16_0226D160_decl.h"
 
 #include "palette.h"
+#include "sprite_system.h"
 
 enum PartyGaugeSide {
     PARTY_GAUGE_OURS,
@@ -41,14 +39,14 @@ enum HideArrowType {
  * @param gfxHandler
  * @param palette
  */
-void PartyGauge_LoadGraphics(SpriteRenderer *renderer, SpriteGfxHandler *gfxHandler, PaletteData *palette);
+void PartyGauge_LoadGraphics(SpriteSystem *spriteSys, SpriteManager *spriteMan, PaletteData *palette);
 
 /**
  * @brief Free the graphics resources needed for the Party Gauge from memory.
  *
  * @param gfxHandler
  */
-void PartyGauge_FreeGraphics(SpriteGfxHandler *gfxHandler);
+void PartyGauge_FreeGraphics(SpriteManager *spriteMan);
 
 /**
  * @brief Show the Party Gauge.
@@ -70,7 +68,7 @@ void PartyGauge_FreeGraphics(SpriteGfxHandler *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);
+PartyGauge *PartyGauge_Show(u8 ballStatus[], enum PartyGaugeSide side, enum ShowPartyGaugeType showType, enum PartyGaugePosition pos, SpriteSystem *spriteSys, SpriteManager *spriteMan);
 
 /**
  * @brief Check if the Party Gauge has finished the inward scrolling animation.

diff --git a/include/battle/struct_ov16_0225BFFC_t.h b/include/battle/struct_ov16_0225BFFC_t.h
@@ -1,8 +1,7 @@
 #ifndef POKEPLATINUM_STRUCT_OV16_0225BFFC_T_H
 #define POKEPLATINUM_STRUCT_OV16_0225BFFC_T_H
 
-#include "struct_decls/cell_actor_data.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 #include "battle/struct_ov16_0225BFFC_sub1.h"
 #include "battle/struct_ov16_022674C4.h"
@@ -12,15 +11,16 @@
 
 #include "bg_window.h"
 #include "narc.h"
+#include "sprite.h"
 #include "sys_task_manager.h"
 
 #define DATA_BUF_SIZE 256
 
 struct BattlerData {
     UnkStruct_ov16_0225BFFC_sub1 unk_00;
-    CellActorData *unk_18;
-    Sprite *unk_1C;
-    Sprite *unk_20;
+    ManagedSprite *unk_18;
+    PokemonSprite *unk_1C;
+    PokemonSprite *unk_20;
     Window *unk_24;
     Healthbar healthbar;
     UnkStruct_ov16_0226C378 unk_7B;

diff --git a/include/battle/struct_ov16_0225D1C4.h b/include/battle/struct_ov16_0225D1C4.h
@@ -2,11 +2,11 @@
 #define POKEPLATINUM_STRUCT_OV16_0225D1C4_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 typedef struct {
     BattleSystem *unk_00;
-    Sprite *unk_04;
+    PokemonSprite *unk_04;
     u8 unk_08;
     u8 unk_09;
     u8 unk_0A;

diff --git a/include/battle/struct_ov16_0225D9A8.h b/include/battle/struct_ov16_0225D9A8.h
@@ -2,7 +2,7 @@
 #define POKEPLATINUM_STRUCT_OV16_0225D9A8_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 #include "battle/struct_ov16_0225BFFC_decl.h"
 #include "battle/struct_ov16_02265BBC.h"
@@ -11,7 +11,7 @@
 typedef struct {
     BattleSystem *unk_00;
     BattlerData *unk_04;
-    Sprite *unk_08;
+    PokemonSprite *unk_08;
     UnkStruct_ov12_0221FCDC *unk_0C;
     UnkStruct_ov16_02265BBC unk_10;
     u8 unk_68;

diff --git a/include/battle/struct_ov16_0225DA44.h b/include/battle/struct_ov16_0225DA44.h
@@ -2,11 +2,11 @@
 #define POKEPLATINUM_STRUCT_OV16_0225DA44_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 typedef struct {
     BattleSystem *unk_00;
-    Sprite *unk_04;
+    PokemonSprite *unk_04;
     u8 unk_08;
     u8 unk_09;
     u8 unk_0A;

diff --git a/include/battle/struct_ov16_0225DB74.h b/include/battle/struct_ov16_0225DB74.h
@@ -2,15 +2,15 @@
 #define POKEPLATINUM_STRUCT_OV16_0225DB74_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 #include "battle/struct_ov16_0225BFFC_decl.h"
 #include "battle/struct_ov16_02265BBC.h"
 
 typedef struct {
     BattleSystem *unk_00;
     BattlerData *unk_04;
-    Sprite *unk_08;
+    PokemonSprite *unk_08;
     UnkStruct_ov16_02265BBC unk_0C;
     u8 unk_64;
     u8 unk_65;

diff --git a/include/battle/struct_ov16_0225E0F4.h b/include/battle/struct_ov16_0225E0F4.h
@@ -2,11 +2,11 @@
 #define POKEPLATINUM_STRUCT_OV16_0225E0F4_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 typedef struct {
     BattleSystem *unk_00;
-    Sprite *unk_04;
+    PokemonSprite *unk_04;
     u8 unk_08;
     u8 unk_09;
     u8 unk_0A;

diff --git a/include/battle/struct_ov16_0225E2C8.h b/include/battle/struct_ov16_0225E2C8.h
@@ -2,14 +2,14 @@
 #define POKEPLATINUM_STRUCT_OV16_0225E2C8_H
 
 #include "struct_decls/battle_system.h"
-#include "struct_decls/sprite_decl.h"
+#include "struct_defs/pokemon_sprite.h"
 
 #include "battle/struct_ov16_0225BFFC_decl.h"
 
 typedef struct {
     BattleSystem *unk_00;
     BattlerData *unk_04;
-    Sprite *unk_08;
+    PokemonSprite *unk_08;
     u8 unk_0C;
     u8 unk_0D;
     u8 unk_0E;