Unify more PokemonSprite references (#807)

Author: ravepossum

include/applications/pokemon_summary_screen/main.h

@@ -6,8 +6,8 @@
 #include "constants/moves.h"
 
 #include "struct_decls/pokemon_animation_sys_decl.h"
-#include "struct_defs/archived_poke_sprite_data.h"
 #include "struct_defs/chatot_cry.h"
+#include "struct_defs/species_sprite_data.h"
 #include "struct_defs/sprite_animation_frame.h"
 
 #include "bg_window.h"
@@ -410,7 +410,7 @@ typedef struct PokemonSummaryMonData {
 typedef struct PokemonSummaryMonSpriteData {
     Camera *camera;
     void *spriteManager;
-    SpriteAnimationFrame frames[MAX_ANIMATION_FRAMES];
+    SpriteAnimFrame frames[MAX_ANIMATION_FRAMES];
     PokemonAnimationSys *animationSys;
     PokemonSprite *sprite;
     BOOL flip;

include/pokemon.h

@@ -838,7 +838,7 @@ void BoxPokemon_RestorePP(BoxPokemon *boxMon);
  * @param species       Species to be loaded
  * @param clientType    Client-type of who made the load request
  */
-void PokeSprite_LoadAnimationFrames(NARC *narc, SpriteAnimationFrame *frames, u16 species, u16 clientType);
+void PokemonSprite_LoadAnimFrames(NARC *narc, SpriteAnimFrame *frames, u16 species, u16 clientType);
 
 /**
  * @brief Load the animation data for a given species and a client type.
@@ -851,7 +851,7 @@ void PokeSprite_LoadAnimationFrames(NARC *narc, SpriteAnimationFrame *frames, u1
  * @param reverse       If TRUE, reverse the sprite + animation
  * @param frame         Which frame of the animation to initialize
  */
-void PokeSprite_LoadAnimation(NARC *narc, PokemonAnimationSys *animationSys, PokemonSprite *sprite, u16 species, int face, int reverse, int frame);
+void PokemonSprite_LoadAnim(NARC *narc, PokemonAnimationSys *animationSys, PokemonSprite *sprite, u16 species, int face, int reverse, int frame);
 
 /**
  * @brief Load the cry delay for a given species and a client type.
@@ -861,7 +861,7 @@ void PokeSprite_LoadAnimation(NARC *narc, PokemonAnimationSys *animationSys, Pok
  * @param species       Species to be loaded
  * @param clientType    Client-type of who made the load request
  */
-void PokeSprite_LoadCryDelay(NARC *narc, u8 *cryDelay, u16 species, u16 clientType);
+void PokemonSprite_LoadCryDelay(NARC *narc, u8 *cryDelay, u16 species, u16 clientType);
 
 /**
  * @brief Load the vertical offset for a given species and a client type.
@@ -871,7 +871,7 @@ void PokeSprite_LoadCryDelay(NARC *narc, u8 *cryDelay, u16 species, u16 clientTy
  * @param species       Species to be loaded
  * @param clientType    Client-type of who made the load request
  */
-void PokeSprite_LoadYOffset(NARC *narc, s8 *yOffset, u16 species);
+void PokemonSprite_LoadYOffset(NARC *narc, s8 *yOffset, u16 species);
 
 /**
  * @brief Load the shadow's horizontal offset for a given species and a client type.
@@ -881,7 +881,7 @@ void PokeSprite_LoadYOffset(NARC *narc, s8 *yOffset, u16 species);
  * @param species               Species to be loaded
  * @param clientType            Client-type of who made the load request
  */
-void PokeSprite_LoadXOffsetShadow(NARC *narc, s8 *xOffsetShadow, u16 species);
+void PokemonSprite_LoadXOffsetShadow(NARC *narc, s8 *xOffsetShadow, u16 species);
 
 /**
  * @brief Load the shadow size for a given species and a client type.
@@ -891,7 +891,7 @@ void PokeSprite_LoadXOffsetShadow(NARC *narc, s8 *xOffsetShadow, u16 species);
  * @param species           Species to be loaded
  * @param clientType        Client-type of who made the load request
  */
-void PokeSprite_LoadShadowSize(NARC *narc, u8 *shadowSize, u16 species);
+void PokemonSprite_LoadShadowSize(NARC *narc, u8 *shadowSize, u16 species);
 BOOL Pokemon_SetBallSeal(int param0, Pokemon *mon, int heapID);
 void sub_02078B40(Pokemon *mon, UnkStruct_02078B40 *param1);
 void sub_02078E0C(UnkStruct_02078B40 *param0, Pokemon *mon);

include/pokemon_sprite.h

@@ -152,7 +152,7 @@ struct PokemonSprite {
     PokemonSpriteCallback *callback;
     PokemonSpriteShadow shadow;
     PokemonSpriteShadow shadowBackup;
-    SpriteAnimationFrame animFrames[MAX_ANIMATION_FRAMES];
+    SpriteAnimFrame animFrames[MAX_ANIMATION_FRAMES];
 };
 
 typedef struct PokemonSpriteManager {
@@ -185,17 +185,17 @@ typedef struct {
     u8 frameDelay;
     u8 loopTimers[MAX_ANIMATION_FRAMES];
     u8 padding_0E[2];
-    const SpriteAnimationFrame *animFrames;
+    const SpriteAnimFrame *animFrames;
 } PokemonSpriteTaskAnim;
 
 void *PokemonSpriteManager_New(enum HeapID heapID);
 void PokemonSpriteManager_DrawSprites(PokemonSpriteManager *monSpriteMan);
 void PokemonSpriteManager_Free(PokemonSpriteManager *monSpriteMan);
 void PokemonSprite_InitAnim(PokemonSprite *monSprite, int dummy);
-void PokemonSprite_SetAnim(PokemonSprite *monSprite, SpriteAnimationFrame *animFrames);
+void PokemonSprite_SetAnimFrames(PokemonSprite *monSprite, SpriteAnimFrame *animFrames);
 BOOL PokemonSprite_IsAnimActive(PokemonSprite *monSprite);
-PokemonSprite *PokemonSpriteManager_CreateSprite(PokemonSpriteManager *monSpriteMan, PokemonSpriteTemplate *spriteTemplate, int x, int y, int z, int polygonID, SpriteAnimationFrame *animFrames, PokemonSpriteCallback *callback);
-PokemonSprite *PokemonSpriteManager_CreateSpriteAtIndex(PokemonSpriteManager *monSpriteMan, PokemonSpriteTemplate *spriteTemplate, int x, int y, int z, int polygonID, int index, SpriteAnimationFrame *animFrames, PokemonSpriteCallback *callback);
+PokemonSprite *PokemonSpriteManager_CreateSprite(PokemonSpriteManager *monSpriteMan, PokemonSpriteTemplate *spriteTemplate, int x, int y, int z, int polygonID, SpriteAnimFrame *animFrames, PokemonSpriteCallback *callback);
+PokemonSprite *PokemonSpriteManager_CreateSpriteAtIndex(PokemonSpriteManager *monSpriteMan, PokemonSpriteTemplate *spriteTemplate, int x, int y, int z, int polygonID, int index, SpriteAnimFrame *animFrames, PokemonSpriteCallback *callback);
 void PokemonSprite_Delete(PokemonSprite *monSprite);
 void PokemonSpriteManager_DeleteAll(PokemonSpriteManager *monSpriteMan);
 void PokemonSprite_SetAttribute(PokemonSprite *monSprite, enum PokemonSpriteAttribute attribute, int value);
@@ -207,7 +207,7 @@ void PokemonSpriteManager_StartFadeAll(PokemonSpriteManager *monSpriteMan, int i
 void PokemonSprite_ClearFade(PokemonSprite *monSprite);
 BOOL PokemonSprite_IsFadeActive(PokemonSprite *monSprite);
 void PokemonSprite_CalcScaledYOffset(PokemonSprite *monSprite, int height);
-void PokemonSpriteTaskAnim_Init(PokemonSpriteTaskAnim *anim, const SpriteAnimationFrame *animFrames);
+void PokemonSpriteTaskAnim_Init(PokemonSpriteTaskAnim *anim, const SpriteAnimFrame *animFrames);
 int PokemonSpriteTaskAnim_Tick(PokemonSpriteTaskAnim *anim);
 void PokemonSprite_ScheduleReloadFromNARC(PokemonSprite *monSprite);
 void PokemonSprite_Push(PokemonSprite *monSprite);

include/struct_defs/archived_poke_sprite_data.h renamed to include/struct_defs/species_sprite_data.h

@@ -1,22 +1,22 @@
-#ifndef POKEPLATINUM_ARCHIVED_POKE_SPRITE_DATA_H
-#define POKEPLATINUM_ARCHIVED_POKE_SPRITE_DATA_H
+#ifndef POKEPLATINUM_SPECIES_SPRITE_DATA_H
+#define POKEPLATINUM_SPECIES_SPRITE_DATA_H
 
 #include "struct_defs/sprite_animation_frame.h"
 
 #define MAX_FACES 2
 
-typedef struct PokeSpriteFaceData {
+typedef struct SpeciesSpriteAnim {
     u8 cryDelay; ///< How long to wait before playing the cry.
     u8 animation; ///< Which pre-programmed animation sequence to use.
     u8 startDelay; ///< How long to wait before starting the animation sequence.
-    SpriteAnimationFrame frames[MAX_ANIMATION_FRAMES]; ///< Frame-data for each frame of the animation sequence.
-} PokeSpriteFaceData;
+    SpriteAnimFrame frames[MAX_ANIMATION_FRAMES]; ///< Frame-data for each frame of the animation sequence.
+} SpeciesSpriteAnim;
 
-typedef struct ArchivedPokeSpriteData {
-    PokeSpriteFaceData faces[MAX_FACES]; ///< Data for each display-face of the Pokemon's sprite.
+typedef struct SpeciesSpriteData {
+    SpeciesSpriteAnim faceAnims[MAX_FACES]; ///< Data for each display-face of the Pokemon's sprite.
     s8 yOffset; ///< Additional vertical offset of the Pokemon's front-face sprite.
     s8 xOffsetShadow; ///< Horizontal offset for the shadow sprite beneath the Pokemon's sprite.
     u8 shadowSize; ///< Size of the shadow sprite beneath the Pokemon's sprite.
-} ArchivedPokeSpriteData;
+} SpeciesSpriteData;
 
-#endif // POKEPLATINUM_ARCHIVED_POKE_SPRITE_DATA_H
+#endif // POKEPLATINUM_SPECIES_SPRITE_DATA_H

include/struct_defs/sprite_animation_frame.h

@@ -6,11 +6,11 @@
 /**
  * @brief By-frame data definition for animating a sprite.
  */
-typedef struct SpriteAnimationFrame {
+typedef struct SpriteAnimFrame {
     s8 spriteFrame; ///< Which frame of the sprite to use for this frame of the animation.
     u8 frameDelay; ///< How long this animation frame should last.
     s8 xOffset; ///< Horizontal shift to apply to the sprite for this animation frame.
     s8 yOffset; ///< Vertical shift to apply to the sprite for this animation frame.
-} SpriteAnimationFrame;
+} SpriteAnimFrame;
 
 #endif // POKEPLATINUM_SPRITE_ANIMATION_DATA_H

src/applications/pokemon_summary_screen/3d_anim.c

@@ -353,7 +353,7 @@ void PokemonSummaryScreen_LoadMonSprite(PokemonSummaryScreen *summaryScreen)
         Pokemon_BuildSpriteTemplate(&spriteTemplate, monData, 2);
     }
 
-    PokeSprite_LoadAnimationFrames(summaryScreen->narcPlPokeData, summaryScreen->monSprite.frames, summaryScreen->monData.species, 1);
+    PokemonSprite_LoadAnimFrames(summaryScreen->narcPlPokeData, summaryScreen->monSprite.frames, summaryScreen->monData.species, 1);
 
     summaryScreen->monSprite.flip = SpeciesData_GetFormValue(summaryScreen->monData.species, summaryScreen->monData.form, SPECIES_DATA_FLIP_SPRITE) ^ 1;
     summaryScreen->monSprite.sprite = PokemonSpriteManager_CreateSprite(summaryScreen->monSprite.spriteManager, &spriteTemplate, 52, 104, 0, 0, summaryScreen->monSprite.frames, NULL);
@@ -364,10 +364,10 @@ void PokemonSummaryScreen_LoadMonSprite(PokemonSummaryScreen *summaryScreen)
 void PokemonSummaryScreen_LoadMonAnimation(PokemonSummaryScreen *summaryScreen)
 {
     if (summaryScreen->monData.isEgg != FALSE) {
-        PokeSprite_LoadAnimation(summaryScreen->narcPlPokeData, summaryScreen->monSprite.animationSys, summaryScreen->monSprite.sprite, 0, 2, summaryScreen->monSprite.flip, 0);
+        PokemonSprite_LoadAnim(summaryScreen->narcPlPokeData, summaryScreen->monSprite.animationSys, summaryScreen->monSprite.sprite, 0, 2, summaryScreen->monSprite.flip, 0);
     } else {
         PokemonSprite_InitAnim(summaryScreen->monSprite.sprite, 1);
-        PokeSprite_LoadAnimation(summaryScreen->narcPlPokeData, summaryScreen->monSprite.animationSys, summaryScreen->monSprite.sprite, summaryScreen->monData.species, 2, summaryScreen->monSprite.flip, 0);
+        PokemonSprite_LoadAnim(summaryScreen->narcPlPokeData, summaryScreen->monSprite.animationSys, summaryScreen->monSprite.sprite, summaryScreen->monData.species, 2, summaryScreen->monSprite.flip, 0);
     }
 }
 

src/applications/pokemon_summary_screen/main.c

@@ -1179,7 +1179,7 @@ static void PlayMonCry(PokemonSummaryScreen *summaryScreen)
     }
 
     u8 cryDelay;
-    PokeSprite_LoadCryDelay(summaryScreen->narcPlPokeData, &cryDelay, summaryScreen->monData.species, 1);
+    PokemonSprite_LoadCryDelay(summaryScreen->narcPlPokeData, &cryDelay, summaryScreen->monData.species, 1);
 
     if (summaryScreen->monData.species == SPECIES_CHATOT) {
         Sound_PlayDelayedChatotCry(summaryScreen->data->chatotCry, 0, 100, 0, cryDelay);