Rename Spark Effect -> Grind Effect, document SA1's and SA2's versions a bit

Author: JaceCear

include/constants/animations.h

@@ -497,7 +497,7 @@
 #define SA2_ANIM_SPINDASH_DUST_EFFECT     846
 #define SA2_ANIM_SPINDASH_DUST_EFFECT_BIG 847
 #define SA2_ANIM_SMALL_DUST_PARTICLE      848
-#define SA2_ANIM_SPARK_EFFECT             849 // Grinding particles
+#define SA2_ANIM_GRIND_EFFECT             849 // Grinding particles
 #define SA2_ANIM_SHIELD_NORMAL            850
 #define SA2_ANIM_SHIELD_MAGNETIC          851
 #define SA2_ANIM_INVINCIBILITY            852

include/game/stage/game_2.h

@@ -23,7 +23,7 @@ typedef struct {
 extern struct Task *sub_801F15C(s16, s16, u8, s8, TaskMain, TaskDestructor);
 extern void TaskDestructor_801F550(struct Task *);
 
-void sub_801F488(void);
+void CreateGrindEffect2(void);
 
 struct Task *CreateStageGoalBonusPointsAnim(s32, s32, u16);
 void Task_801F214(void);

ldscript.txt

@@ -176,7 +176,7 @@ SECTIONS
         src/game/stage/game_2.o(.text);
         src/game/stage/dust_effect_braking.o(.text);
         src/game/stage/dust_effect_spindash.o(.text);
-        src/game/stage/spark_effect.o(.text);
+        src/game/stage/grind_effect_1.o(.text);
         src/game/stage/rings_scatter.o(.text);
 
         /* player */

src/game/stage/game_2.c

@@ -171,7 +171,7 @@ struct Task *CreateStageGoalBonusPointsAnim(s32 x, s32 y, u16 score)
     }
 }
 
-void sub_801F488(void)
+void CreateGrindEffect2(void)
 {
     Player *p = &gPlayer;
     if ((gStageTime & 0x7) == 0) {
@@ -201,7 +201,7 @@ void sub_801F488(void)
         ts = TASK_DATA(t);
         s = &ts->s;
         s->graphics.dest = VramMalloc(20);
-        s->graphics.anim = SA2_ANIM_SPARK_EFFECT;
+        s->graphics.anim = SA2_ANIM_GRIND_EFFECT;
         s->variant = 0;
         s->oamFlags = SPRITE_OAM_ORDER(8);
         s->frameFlags = SPRITE_FLAG(PRIORITY, 1);
@@ -223,7 +223,7 @@ struct Task *sub_801F568(s16 x, s16 y)
     Sprite *s = &ts->s;
 
     s->graphics.dest = VramMalloc(20);
-    s->graphics.anim = SA2_ANIM_SPARK_EFFECT;
+    s->graphics.anim = SA2_ANIM_GRIND_EFFECT;
     s->variant = 0;
     s->oamFlags = SPRITE_OAM_ORDER(8);
     s->frameFlags = SPRITE_FLAG(PRIORITY, 1);

src/game/stage/spark_effect.c src/game/stage/grind_effect_1.csrc/game/stage/spark_effect.c renamed to src/game/stage/grind_effect_1.c

@@ -9,21 +9,23 @@
 
 typedef struct {
     Sprite s;
-} SparkEffect;
+} GrindEffect;
 
-void Task_SparkEffect(void);
-void TaskDestructor_SparkEffect(struct Task *);
+void Task_GrindEffect(void);
+void TaskDestructor_GrindEffect(struct Task *);
 
-// NOTE: This effect appears to be unused
-struct Task *CreateSparkEffect()
+// NOTE: This effect is unused in SA2.
+//       It is the code for SA1's Grind effect
+
+struct Task *CreateGrindEffect()
 {
-    struct Task *t = TaskCreate(Task_SparkEffect, sizeof(SparkEffect), 0x2001, 0, TaskDestructor_SparkEffect);
+    struct Task *t = TaskCreate(Task_GrindEffect, sizeof(GrindEffect), 0x2001, 0, TaskDestructor_GrindEffect);
 
-    SparkEffect *spark = TASK_DATA(t);
+    GrindEffect *spark = TASK_DATA(t);
     Sprite *s = &spark->s;
     s->graphics.dest = VramMalloc(20);
     s->graphics.size = 0;
-    s->graphics.anim = SA2_ANIM_SPARK_EFFECT;
+    s->graphics.anim = SA2_ANIM_GRIND_EFFECT;
     s->variant = 0;
     s->prevVariant = -1;
     s->oamFlags = SPRITE_OAM_ORDER(8);
@@ -35,15 +37,15 @@ struct Task *CreateSparkEffect()
     return t;
 }
 
-void Task_SparkEffect(void)
+void Task_GrindEffect(void)
 {
     Player *p = &gPlayer;
 
     if (p->spriteTask == NULL || !(p->moveState & MOVESTATE_1000000)) {
         TaskDestroy(gCurTask);
         return;
     } else if ((p->anim == SA2_CHAR_ANIM_55) && (p->variant == 0)) {
-        SparkEffect *spark = TASK_DATA(gCurTask);
+        GrindEffect *spark = TASK_DATA(gCurTask);
         Sprite *s = &spark->s;
         struct Camera *cam = &gCamera;
         s->x = I(p->x) - cam->x;
@@ -60,8 +62,8 @@ void Task_SparkEffect(void)
     }
 }
 
-void TaskDestructor_SparkEffect(struct Task *t)
+void TaskDestructor_GrindEffect(struct Task *t)
 {
-    SparkEffect *spark = TASK_DATA(t);
+    GrindEffect *spark = TASK_DATA(t);
     VramFree(spark->s.graphics.dest);
 }

src/game/stage/player.c

@@ -4767,10 +4767,8 @@ void Player_DoGrinding(Player *p)
             gPlayer.moveState &= ~MOVESTATE_IN_SCRIPTED;
             m4aSongNumStop(SE_GRINDING);
             PLAYERFN_SET(Player_Jumping);
-        } else {
-            if (IS_SINGLE_PLAYER) {
-                sub_801F488();
-            }
+        } else if (IS_SINGLE_PLAYER) {
+            CreateGrindEffect2();
         }
     }
 }