Skip to content

Commit aa54c2e

Browse files
Copilotbates64
andcommitted
Rename BATTLE_STATE_9 to BATTLE_STATE_END_TEAM_TURN with meaningful substates
Co-authored-by: bates64 <9429556+bates64@users.noreply.github.com>
1 parent 574711f commit aa54c2e

File tree

6 files changed

+44
-44
lines changed

6 files changed

+44
-44
lines changed

include/enums.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3665,7 +3665,7 @@ enum BattleStates {
36653665
BATTLE_STATE_END_TURN = 6,
36663666
BATTLE_STATE_BEGIN_PLAYER_TURN = 7,
36673667
BATTLE_STATE_BEGIN_PARTNER_TURN = 8,
3668-
BATTLE_STATE_9 = 9, // can be reached from BATTLE_STATE_PARTNER_MOVE if partner == nullptr
3668+
BATTLE_STATE_END_TEAM_TURN = 9, // can be reached from BATTLE_STATE_PARTNER_MOVE if partner == nullptr
36693669
BATTLE_STATE_SWITCH_TO_PLAYER = 10,
36703670
BATTLE_STATE_SWITCH_TO_PARTNER = 11,
36713671
BATTLE_STATE_PREPARE_MENU = 12,
@@ -3758,15 +3758,15 @@ enum BattleSubStates {
37583758
BTL_SUBSTATE_BEGIN_PARTNER_TURN_END_DELAY = 10,
37593759
BTL_SUBSTATE_BEGIN_PARTNER_TURN_RESET_STATE = 100,
37603760

3761-
// BATTLE_STATE_9
3762-
BTL_SUBSTATE_9_INIT = 0,
3763-
BTL_SUBSTATE_9_1 = 1,
3764-
BTL_SUBSTATE_9_2 = 2,
3765-
BTL_SUBSTATE_9_3 = 3,
3766-
BTL_SUBSTATE_9_4 = 4,
3767-
BTL_SUBSTATE_9_5 = 5,
3768-
BTL_SUBSTATE_9_6 = 6,
3769-
BTL_SUBSTATE_9_7 = 7,
3761+
// BATTLE_STATE_END_TEAM_TURN
3762+
BTL_SUBSTATE_END_TEAM_TURN_INIT = 0,
3763+
BTL_SUBSTATE_END_TEAM_TURN_PROCESS_STATUS = 1,
3764+
BTL_SUBSTATE_END_TEAM_TURN_AWAIT_SCRIPTS = 2,
3765+
BTL_SUBSTATE_END_TEAM_TURN_SWAP_POSITIONS = 3,
3766+
BTL_SUBSTATE_END_TEAM_TURN_HANDLE_MERLEE = 4,
3767+
BTL_SUBSTATE_END_TEAM_TURN_EXEC_PHASE_SCRIPTS = 5,
3768+
BTL_SUBSTATE_END_TEAM_TURN_AWAIT_PHASE_SCRIPTS = 6,
3769+
BTL_SUBSTATE_END_TEAM_TURN_DONE = 7,
37703770

37713771
// BATTLE_STATE_SWITCH_TO_PLAYER
37723772
// BATTLE_STATE_SWITCH_TO_PARTNER

include/functions.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,8 @@ void btl_state_update_begin_partner_turn(void);
334334
void btl_state_draw_begin_partner_turn(void);
335335
void btl_state_update_switch_to_partner(void);
336336
void btl_state_draw_switch_to_partner(void);
337-
void btl_state_update_9(void);
338-
void btl_state_draw_9(void);
337+
void btl_state_update_end_team_turn(void);
338+
void btl_state_draw_end_team_turn(void);
339339
void btl_state_update_prepare_menu(void);
340340
void btl_state_draw_prepare_menu(void);
341341
void btl_state_update_end_turn(void);

src/battle/16C8E0.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,8 +317,8 @@ void btl_update(void) {
317317
case BATTLE_STATE_BEGIN_PARTNER_TURN:
318318
btl_state_update_begin_partner_turn();
319319
break;
320-
case BATTLE_STATE_9:
321-
btl_state_update_9();
320+
case BATTLE_STATE_END_TEAM_TURN:
321+
btl_state_update_end_team_turn();
322322
break;
323323
case BATTLE_STATE_BEGIN_TURN:
324324
btl_state_update_begin_turn();
@@ -528,8 +528,8 @@ void btl_draw_ui(void) {
528528
case BATTLE_STATE_BEGIN_PARTNER_TURN:
529529
btl_state_draw_begin_partner_turn();
530530
break;
531-
case BATTLE_STATE_9:
532-
btl_state_draw_9();
531+
case BATTLE_STATE_END_TEAM_TURN:
532+
btl_state_draw_end_team_turn();
533533
break;
534534
case BATTLE_STATE_BEGIN_TURN:
535535
btl_state_draw_begin_turn();

src/battle/area/hos/actor/goombario_tutor.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ EvtScript N(EVS_ManageTutorial) = {
362362
Call(UseIdleAnimation, ACTOR_PARTNER, false)
363363
Call(ActorSpeak, MSG_HOS_001D, ACTOR_PARTNER, 1, ANIM_Twink_Talk, ANIM_Twink_Fly)
364364
Call(UseIdleAnimation, ACTOR_PARTNER, true)
365-
Call(WaitForState, BATTLE_STATE_9)
365+
Call(WaitForState, BATTLE_STATE_END_TEAM_TURN)
366366
Call(UseBattleCamPreset, BTL_CAM_DEFAULT)
367367
Wait(15)
368368
Call(UseIdleAnimation, ACTOR_PARTNER, false)

src/battle/btl_states_actions.c

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1110,11 +1110,11 @@ void btl_state_update_begin_partner_turn(void) {
11101110
btl_cam_move(5);
11111111
gBattleSubState = BTL_SUBSTATE_BEGIN_PARTNER_TURN_RESET_STATE;
11121112
} else {
1113-
btl_set_state(BATTLE_STATE_9);
1113+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
11141114
return;
11151115
}
11161116
} else {
1117-
btl_set_state(BATTLE_STATE_9);
1117+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
11181118
return;
11191119
}
11201120
}
@@ -1198,7 +1198,7 @@ void btl_state_update_begin_partner_turn(void) {
11981198
btl_set_state(BATTLE_STATE_SWITCH_TO_PARTNER);
11991199
} else {
12001200
gBattleStatus.flags2 |= BS_FLAGS2_PARTNER_TURN_USED;
1201-
btl_set_state(BATTLE_STATE_9);
1201+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
12021202
}
12031203
}
12041204
}
@@ -1236,7 +1236,7 @@ void btl_state_update_switch_to_partner(void) {
12361236
void btl_state_draw_switch_to_partner(void) {
12371237
}
12381238

1239-
void btl_state_update_9(void) {
1239+
void btl_state_update_end_team_turn(void) {
12401240
BattleStatus* battleStatus = &gBattleStatus;
12411241
Actor* player = battleStatus->playerActor;
12421242
Actor* partner = battleStatus->partnerActor;
@@ -1248,7 +1248,7 @@ void btl_state_update_9(void) {
12481248

12491249
s32 oldKoDuration;
12501250

1251-
if (gBattleSubState == BTL_SUBSTATE_9_INIT) {
1251+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_INIT) {
12521252
if (!(gBattleStatus.flags2 & BS_FLAGS2_PLAYER_TURN_USED)) {
12531253
btl_set_state(BATTLE_STATE_SWITCH_TO_PLAYER);
12541254
return;
@@ -1268,15 +1268,15 @@ void btl_state_update_9(void) {
12681268
partner->flags |= ACTOR_FLAG_USING_IDLE_ANIM;
12691269
}
12701270

1271-
gBattleSubState = BTL_SUBSTATE_9_1;
1271+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_PROCESS_STATUS;
12721272
D_8029F258 = 0;
12731273
gBattleStatus.flags2 &= ~BS_FLAGS2_PLAYER_TURN_USED;
12741274
gBattleStatus.flags2 &= ~BS_FLAGS2_PARTNER_TURN_USED;
12751275
gBattleStatus.flags2 &= ~BS_FLAGS2_OVERRIDE_INACTIVE_PLAYER;
12761276
gBattleStatus.flags2 &= ~BS_FLAGS2_OVERRIDE_INACTIVE_PARTNER;
12771277
}
12781278

1279-
if (gBattleSubState == BTL_SUBSTATE_9_1) {
1279+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_PROCESS_STATUS) {
12801280
waitingForScript = false;
12811281
for (i = 0; i < ARRAY_COUNT(battleStatus->enemyActors); i++) {
12821282
actor = battleStatus->enemyActors[i];
@@ -1359,11 +1359,11 @@ void btl_state_update_9(void) {
13591359
}
13601360
}
13611361
}
1362-
gBattleSubState = BTL_SUBSTATE_9_2;
1362+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_AWAIT_SCRIPTS;
13631363
}
13641364
}
13651365

1366-
if (gBattleSubState == BTL_SUBSTATE_9_2) {
1366+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_AWAIT_SCRIPTS) {
13671367
// wait for player HandleEvent script to finish
13681368
if(player->handleEventScript != nullptr && does_script_exist(player->handleEventScriptID)) {
13691369
goto WAITING;
@@ -1402,9 +1402,9 @@ void btl_state_update_9(void) {
14021402

14031403
btl_cam_use_preset(BTL_CAM_DEFAULT);
14041404
if (partner == nullptr || !(gBattleStatus.flags1 & BS_FLAGS1_PLAYER_IN_BACK)) {
1405-
gBattleSubState = BTL_SUBSTATE_9_4;
1405+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_HANDLE_MERLEE;
14061406
} else if (gBattleStatus.flags2 & BS_FLAGS2_PEACH_BATTLE) {
1407-
gBattleSubState = BTL_SUBSTATE_9_4;
1407+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_HANDLE_MERLEE;
14081408
} else {
14091409
player->flags &= ~ACTOR_FLAG_SHOW_STATUS_ICONS;
14101410
partner->flags &= ~ACTOR_FLAG_SHOW_STATUS_ICONS;
@@ -1426,12 +1426,12 @@ void btl_state_update_9(void) {
14261426
}
14271427
state->moveTime = 4;
14281428
state->angle = 0.0f;
1429-
gBattleSubState = BTL_SUBSTATE_9_3;
1429+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_SWAP_POSITIONS;
14301430
}
14311431
}
14321432
WAITING:
14331433

1434-
if (gBattleSubState == BTL_SUBSTATE_9_3) {
1434+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_SWAP_POSITIONS) {
14351435
if (partner->state.moveTime != 0) {
14361436
partner->curPos.x += (partner->state.goalPos.x - partner->curPos.x) / partner->state.moveTime;
14371437
partner->curPos.z += (partner->state.goalPos.z - partner->curPos.z) / partner->state.moveTime;
@@ -1460,12 +1460,12 @@ void btl_state_update_9(void) {
14601460
player->homePos.x = player->curPos.x;
14611461
player->homePos.z = player->curPos.z;
14621462
}
1463-
gBattleSubState = BTL_SUBSTATE_9_4;
1463+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_HANDLE_MERLEE;
14641464
gBattleStatus.flags1 &= ~BS_FLAGS1_PLAYER_IN_BACK;
14651465
}
14661466
}
14671467

1468-
if (gBattleSubState == BTL_SUBSTATE_9_4) {
1468+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_HANDLE_MERLEE) {
14691469
if (D_8029F258 != 0) {
14701470
D_8029F258--;
14711471
} else {
@@ -1485,15 +1485,15 @@ void btl_state_update_9(void) {
14851485
partner->flags &= ~ACTOR_FLAG_SHOW_STATUS_ICONS;
14861486
partner->flags |= ACTOR_FLAG_USING_IDLE_ANIM;
14871487
}
1488-
gBattleSubState = BTL_SUBSTATE_9_5;
1488+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_EXEC_PHASE_SCRIPTS;
14891489
gBattleStatus.flags2 &= ~BS_FLAGS2_PLAYER_TURN_USED;
14901490
gBattleStatus.flags2 &= ~BS_FLAGS2_PARTNER_TURN_USED;
14911491
gBattleStatus.flags2 &= ~BS_FLAGS2_OVERRIDE_INACTIVE_PLAYER;
14921492
gBattleStatus.flags2 &= ~BS_FLAGS2_OVERRIDE_INACTIVE_PARTNER;
14931493
}
14941494
}
14951495

1496-
if (gBattleSubState == BTL_SUBSTATE_9_5) {
1496+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_EXEC_PHASE_SCRIPTS) {
14971497
if (player->takeTurnScript == nullptr || (does_script_exist(player->takeTurnScriptID) == 0)) {
14981498
player->takeTurnScript = nullptr;
14991499

@@ -1507,29 +1507,29 @@ void btl_state_update_9(void) {
15071507
script->owner1.enemyID = i | ACTOR_CLASS_ENEMY;
15081508
}
15091509
}
1510-
gBattleSubState = BTL_SUBSTATE_9_6;
1510+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_AWAIT_PHASE_SCRIPTS;
15111511
}
15121512
}
15131513

15141514
waitingForScript = false;
1515-
if (gBattleSubState == BTL_SUBSTATE_9_6) {
1515+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_AWAIT_PHASE_SCRIPTS) {
15161516
for (i = 0; i < ARRAY_COUNT(battleStatus->enemyActors); i++) {
15171517
actor = battleStatus->enemyActors[i];
15181518
if (actor != nullptr && actor->handlePhaseSource != nullptr && does_script_exist(actor->handleBatttlePhaseScriptID)) {
15191519
waitingForScript = true;
15201520
}
15211521
}
15221522
if (!waitingForScript) {
1523-
gBattleSubState = BTL_SUBSTATE_9_7;
1523+
gBattleSubState = BTL_SUBSTATE_END_TEAM_TURN_DONE;
15241524
}
15251525
}
15261526

1527-
if (gBattleSubState == BTL_SUBSTATE_9_7) {
1527+
if (gBattleSubState == BTL_SUBSTATE_END_TEAM_TURN_DONE) {
15281528
btl_set_state(BATTLE_STATE_NEXT_ENEMY);
15291529
}
15301530
}
15311531

1532-
void btl_state_draw_9(void) {
1532+
void btl_state_draw_end_team_turn(void) {
15331533
}
15341534

15351535
void btl_state_update_prepare_menu(void) {
@@ -2361,7 +2361,7 @@ void btl_state_update_run_away(void) {
23612361
&& (partner == nullptr || !does_script_exist(partner->takeTurnScriptID))
23622362
&& battleStatus->stateFreezeCount == 0
23632363
) {
2364-
btl_set_state(BATTLE_STATE_9);
2364+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
23652365
}
23662366
break;
23672367
}
@@ -3139,7 +3139,7 @@ void btl_state_update_end_player_turn(void) {
31393139
if (!(gBattleStatus.flags2 & BS_FLAGS2_PEACH_BATTLE)) {
31403140
btl_set_state(BATTLE_STATE_BEGIN_PARTNER_TURN);
31413141
} else {
3142-
btl_set_state(BATTLE_STATE_9);
3142+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
31433143
}
31443144
}
31453145
}
@@ -3164,7 +3164,7 @@ void btl_state_update_partner_move(void) {
31643164
switch (gBattleSubState) {
31653165
case BTL_SUBSTATE_PARTNER_MOVE_INIT:
31663166
if (partner == nullptr) {
3167-
btl_set_state(BATTLE_STATE_9);
3167+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
31683168
break;
31693169
}
31703170
battleStatus->stateFreezeCount = 0;
@@ -3431,7 +3431,7 @@ void btl_state_update_end_partner_turn(void) {
34313431
battleStatus->unk_94 = 0;
34323432
btl_set_state(BATTLE_STATE_END_TURN);
34333433
} else {
3434-
btl_set_state(BATTLE_STATE_9);
3434+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
34353435
}
34363436
}
34373437
}

src/battle/btl_states_menus.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4010,7 +4010,7 @@ void btl_state_update_partner_menu(void) {
40104010
battleStatus->selectedMoveID = MOVE_NONE;
40114011
battleStatus->curAttackElement = 0;
40124012
if (!can_switch_to_partner()) {
4013-
btl_set_state(BATTLE_STATE_9);
4013+
btl_set_state(BATTLE_STATE_END_TEAM_TURN);
40144014
} else {
40154015
btl_cam_use_preset(BTL_CAM_DEFAULT);
40164016
battleStatus->flags1 |= BS_FLAGS1_MENU_OPEN;

0 commit comments

Comments
 (0)