From f12c321845ea1a3ddfff17ae66898fbd4b575fa1 Mon Sep 17 00:00:00 2001 From: Eduardo Quezada Date: Tue, 6 May 2025 15:51:26 -0400 Subject: [PATCH] `InitSpritePosToAnimAttacker` documentation (#6781) --- src/battle_anim_electric.c | 2 +- src/battle_anim_mons.c | 24 ++++++++++++------------ src/battle_anim_new.c | 24 ++++++++++++------------ src/battle_anim_psychic.c | 2 +- src/battle_anim_water.c | 10 +++++----- 5 files changed, 31 insertions(+), 31 deletions(-) diff --git a/src/battle_anim_electric.c b/src/battle_anim_electric.c index bd010797a1..9f461528f5 100644 --- a/src/battle_anim_electric.c +++ b/src/battle_anim_electric.c @@ -1581,7 +1581,7 @@ static void VoltSwitch_Step(struct Sprite* sprite) void AnimTask_VoltSwitch(struct Sprite* sprite) { - InitSpritePosToAnimAttacker(sprite, 0); + InitSpritePosToAnimAttacker(sprite, FALSE); if (GetBattlerSide(gBattleAnimAttacker) == B_SIDE_OPPONENT) gBattleAnimArgs[2] = -gBattleAnimArgs[2]; diff --git a/src/battle_anim_mons.c b/src/battle_anim_mons.c index 43f2be9ae5..da983c7326 100644 --- a/src/battle_anim_mons.c +++ b/src/battle_anim_mons.c @@ -1434,21 +1434,21 @@ static u8 UNUSED GetSpritePalIdxByPosition(u8 position) // 2, 3 as some control variables void AnimSpriteOnMonPos(struct Sprite *sprite) { - bool8 var; + bool8 respectMonPicOffsets; if (!sprite->data[0]) { if (!gBattleAnimArgs[3]) - var = TRUE; + respectMonPicOffsets = TRUE; else - var = FALSE; + respectMonPicOffsets = FALSE; if (gBattleAnimArgs[2] == 0) - InitSpritePosToAnimAttacker(sprite, var); + InitSpritePosToAnimAttacker(sprite, respectMonPicOffsets); else if (gBattleAnimArgs[2] == 1) - InitSpritePosToAnimTarget(sprite, var); + InitSpritePosToAnimTarget(sprite, respectMonPicOffsets); else if (gBattleAnimArgs[2] == 2) - InitSpritePosToAnimAttackerPartner(sprite, var); + InitSpritePosToAnimAttackerPartner(sprite, respectMonPicOffsets); sprite->data[0]++; @@ -1520,32 +1520,32 @@ static void AnimThrowProjectile_Step(struct Sprite *sprite) void AnimTravelDiagonally(struct Sprite *sprite) { - bool8 r4; + bool8 respectOffsets; u8 battlerId, coordType; if (!gBattleAnimArgs[6]) { - r4 = TRUE; + respectOffsets = TRUE; coordType = BATTLER_COORD_Y_PIC_OFFSET; } else { - r4 = FALSE; + respectOffsets = FALSE; coordType = BATTLER_COORD_Y; } if (gBattleAnimArgs[5] == ANIM_ATTACKER) { - InitSpritePosToAnimAttacker(sprite, r4); + InitSpritePosToAnimAttacker(sprite, respectOffsets); battlerId = gBattleAnimAttacker; } else { - InitSpritePosToAnimTarget(sprite, r4); + InitSpritePosToAnimTarget(sprite, respectOffsets); battlerId = gBattleAnimTarget; } if (GetBattlerSide(gBattleAnimAttacker)) gBattleAnimArgs[2] = -gBattleAnimArgs[2]; - InitSpritePosToAnimTarget(sprite, r4); + InitSpritePosToAnimTarget(sprite, respectOffsets); sprite->data[0] = gBattleAnimArgs[4]; sprite->data[2] = GetBattlerSpriteCoord(battlerId, BATTLER_COORD_X_2) + gBattleAnimArgs[2]; sprite->data[4] = GetBattlerSpriteCoord(battlerId, coordType) + gBattleAnimArgs[3]; diff --git a/src/battle_anim_new.c b/src/battle_anim_new.c index eef723f7e7..50fd8f3f0b 100644 --- a/src/battle_anim_new.c +++ b/src/battle_anim_new.c @@ -7538,28 +7538,28 @@ static void AnimBlastBurnTargetPlume_Step1(struct Sprite *sprite) static void SpriteCB_SpriteToCentreOfSide(struct Sprite *sprite) { - bool8 var; + bool8 respectMonPicOffsets; if (!sprite->data[0]) { if (!gBattleAnimArgs[3]) - var = TRUE; + respectMonPicOffsets = TRUE; else - var = FALSE; + respectMonPicOffsets = FALSE; if (gBattleAnimArgs[2] == 0) //Attacker { if (IsDoubleBattle()) - InitSpritePosToAnimAttackersCentre(sprite, var); + InitSpritePosToAnimAttackersCentre(sprite, respectMonPicOffsets); else - InitSpritePosToAnimAttacker(sprite, var); + InitSpritePosToAnimAttacker(sprite, respectMonPicOffsets); } else { if (IsDoubleBattle()) - InitSpritePosToAnimTargetsCentre(sprite, var); + InitSpritePosToAnimTargetsCentre(sprite, respectMonPicOffsets); else - InitSpritePosToAnimTarget(sprite, var); + InitSpritePosToAnimTarget(sprite, respectMonPicOffsets); } sprite->data[0]++; @@ -7698,21 +7698,21 @@ static void SpriteCB_CoreEnforcerBeam(struct Sprite *sprite) static void SpriteCB_TranslateAnimSpriteToTargetMonLocationDoubles(struct Sprite *sprite) { - bool8 v1; + bool8 respectMonPicOffsets; u8 target; u8 coordType; if (!(gBattleAnimArgs[5] & 0xff00)) - v1 = TRUE; + respectMonPicOffsets = TRUE; else - v1 = FALSE; + respectMonPicOffsets = FALSE; if (!(gBattleAnimArgs[5] & 0xff)) coordType = BATTLER_COORD_Y_PIC_OFFSET; else coordType = BATTLER_COORD_Y; - InitSpritePosToAnimAttacker(sprite, v1); + InitSpritePosToAnimAttacker(sprite, respectMonPicOffsets); if (GetBattlerSide(gBattleAnimAttacker) != B_SIDE_PLAYER) gBattleAnimArgs[2] = -gBattleAnimArgs[2]; @@ -8068,7 +8068,7 @@ static void SpriteCB_PyroBallRockBounceStep(struct Sprite *sprite) static void InitSpritePositionForPyroBall(struct Sprite *sprite) { - InitSpritePosToAnimAttacker(sprite, 0); + InitSpritePosToAnimAttacker(sprite, FALSE); sprite->y += 20; //Move closer to attacker's feet if (GetBattlerSide(gBattleAnimAttacker) == B_SIDE_PLAYER) diff --git a/src/battle_anim_psychic.c b/src/battle_anim_psychic.c index 1c342f424b..327c04e34a 100644 --- a/src/battle_anim_psychic.c +++ b/src/battle_anim_psychic.c @@ -516,7 +516,7 @@ static void AnimPsychoCut(struct Sprite *sprite) } } - InitSpritePosToAnimAttacker(sprite, 1); + InitSpritePosToAnimAttacker(sprite, TRUE); lVarX = GetBattlerSpriteCoord(gBattleAnimTarget, BATTLER_COORD_X_2) + gBattleAnimArgs[2]; lVarY = GetBattlerSpriteCoord(gBattleAnimTarget, BATTLER_COORD_Y_PIC_OFFSET) + gBattleAnimArgs[3]; diff --git a/src/battle_anim_water.c b/src/battle_anim_water.c index 996ae9867e..3470adddb6 100644 --- a/src/battle_anim_water.c +++ b/src/battle_anim_water.c @@ -614,7 +614,7 @@ static void AnimAquaTail(struct Sprite *sprite) { StartSpriteAffineAnim(sprite, gBattleAnimArgs[3]); if (gBattleAnimArgs[2] == 0) - InitSpritePosToAnimAttacker(sprite, 1); + InitSpritePosToAnimAttacker(sprite, TRUE); else InitSpritePosToAnimTarget(sprite, TRUE); @@ -945,7 +945,7 @@ static void AnimHydroCannonCharge_Step(struct Sprite *sprite) // Flashing blue orbs move from the attacker to the target. Second stage of Hydro Cannon static void AnimHydroCannonBeam(struct Sprite *sprite) { - bool8 animType; + bool8 respectMonPicOffsets; u8 coordType; if (IsBattlerAlly(gBattleAnimAttacker, gBattleAnimTarget)) { @@ -954,14 +954,14 @@ static void AnimHydroCannonBeam(struct Sprite *sprite) gBattleAnimArgs[0] *= -1; } if ((gBattleAnimArgs[5] & 0xFF00) == 0) - animType = TRUE; + respectMonPicOffsets = TRUE; else - animType = FALSE; + respectMonPicOffsets = FALSE; if ((u8)gBattleAnimArgs[5] == 0) coordType = BATTLER_COORD_Y_PIC_OFFSET; else coordType = BATTLER_COORD_Y; - InitSpritePosToAnimAttacker(sprite, animType); + InitSpritePosToAnimAttacker(sprite, respectMonPicOffsets); if (GetBattlerSide(gBattleAnimAttacker) != B_SIDE_PLAYER) gBattleAnimArgs[2] = -gBattleAnimArgs[2]; sprite->data[0] = gBattleAnimArgs[4];