more documenation

This commit is contained in:
Seth Barberee 2024-09-28 07:26:09 -07:00
parent 52d4d97a82
commit a2c23310bc
5 changed files with 103 additions and 89 deletions

View File

@ -27,7 +27,7 @@ static void UpdateFelicityBankDialogue(void);
static void UpdateFelicityBankState(u32 newState);
static void sub_801645C(void);
static void sub_80169BC(void);
static void HandleFelicityBankShopMenu(void);
static void sub_8016B00(void);
static void sub_8016B24(void);
static void sub_8016B48(u8 action);
@ -39,6 +39,18 @@ enum MenuActions {
INFO_ACTION
};
enum FelicityBankStates {
FELICITY_BANK_INIT,
FELICITY_BANK_INFO = 3,
FELICITY_BANK_EXIT = 6,
FELICITY_BANK_STORE,
FELICITY_BANK_STORE_HOW_MUCH,
FELICITY_BANK_STORE_RECEIPT,
FELICITY_BANK_TAKE,
FELICITY_BANK_TAKE_HOW_MUCH,
FELICITY_BANK_TAKE_DEPOSIT,
};
bool8 CreateFelicityBank(s32 mode)
{
u8 *monName;
@ -67,7 +79,7 @@ bool8 CreateFelicityBank(s32 mode)
sFelicityBankWork->unkA2 = 0;
sFelicityBankWork->unk9C = 2;
sFelicityBankWork->unk9E = 8;
UpdateFelicityBankState(0);
UpdateFelicityBankState(FELICITY_BANK_INIT);
return TRUE;
}
@ -78,24 +90,24 @@ u32 FelicityBankCallback(void)
sub_8016B24();
break;
case 2:
sub_80169BC();
HandleFelicityBankShopMenu();
break;
case 8:
case FELICITY_BANK_STORE_HOW_MUCH:
Felicity_DepositMoney();
break;
case 11:
case FELICITY_BANK_TAKE_HOW_MUCH:
Felicity_WithdrawMoney();
break;
case 6:
case FELICITY_BANK_EXIT:
return 3;
case 0:
case 3:
case FELICITY_BANK_INIT:
case FELICITY_BANK_INFO:
case 4:
case 5:
case 7:
case 9:
case 10:
case 12:
case FELICITY_BANK_STORE:
case FELICITY_BANK_STORE_RECEIPT:
case FELICITY_BANK_TAKE:
case FELICITY_BANK_TAKE_DEPOSIT:
default:
sub_8016B00();
break;
@ -134,8 +146,8 @@ static void sub_801645C(void)
ResetUnusedInputStruct();
xxx_call_save_unk_text_struct_800641C(sFelicityBankWork->unkA8, TRUE, FALSE);
break;
case 8:
case 11:
case FELICITY_BANK_STORE_HOW_MUCH:
case FELICITY_BANK_TAKE_HOW_MUCH:
sFelicityBankWork->unkA8[0].unk0 = 0x80;
sFelicityBankWork->unkA8[1].unk0 = 0x80;
sFelicityBankWork->unkA8[3] = sUnknown_80DB6F4;
@ -156,7 +168,7 @@ static void sub_801645C(void)
static void UpdateFelicityBankDialogue(void)
{
switch (sFelicityBankWork->currState) {
case 0:
case FELICITY_BANK_INIT:
sFelicityBankWork->fallbackState = 1;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_WELCOME], 0, sFelicityBankWork->unkA4, 0x10D);
break;
@ -172,12 +184,12 @@ static void UpdateFelicityBankDialogue(void)
sFelicityBankWork->unk14, sFelicityBankWork->unk54, 4, 0, sFelicityBankWork->unkA4, 0xC);
}
break;
case 3:
case FELICITY_BANK_INFO:
sFelicityBankWork->fallbackState = 1;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_HOW_IT_WORKS], 0, sFelicityBankWork->unkA4, 0x10D);
break;
case 4:
sFelicityBankWork->fallbackState = 6;
sFelicityBankWork->fallbackState = FELICITY_BANK_EXIT;
if (gTeamInventoryRef->teamSavings == 0)
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_BYE__NO_MONEY], 0, sFelicityBankWork->unkA4, 0x10D);
else {
@ -189,7 +201,7 @@ static void UpdateFelicityBankDialogue(void)
sFelicityBankWork->fallbackState = 1;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_VERY_WELL], 0, sFelicityBankWork->unkA4, 0x10D);
break;
case 7:
case FELICITY_BANK_STORE:
if (gTeamInventoryRef->teamMoney == 0) {
sFelicityBankWork->fallbackState = 1;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_DEPOSIT__NO_MONEY], 0, sFelicityBankWork->unkA4, 0x10D);
@ -199,11 +211,11 @@ static void UpdateFelicityBankDialogue(void)
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_DEPOSIT__BANK_FULL], 0, sFelicityBankWork->unkA4, 0x10D);
}
else {
sFelicityBankWork->fallbackState = 8;
sFelicityBankWork->fallbackState = FELICITY_BANK_STORE_HOW_MUCH;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_DEPOSIT__HOW_MUCH], 0, sFelicityBankWork->unkA4, 0x10D);
}
break;
case 8:
case FELICITY_BANK_STORE_HOW_MUCH:
sFelicityBankWork->unk64.unkC = MAX_TEAM_SAVINGS - gTeamInventoryRef->teamSavings;
if (sFelicityBankWork->unk64.unkC > gTeamInventoryRef->teamMoney)
sFelicityBankWork->unk64.unkC = gTeamInventoryRef->teamMoney;
@ -218,12 +230,12 @@ static void UpdateFelicityBankDialogue(void)
sub_8016B48(FELICITY_BANK_ACTION_DEPOSIT);
CreateFelicityMoneySavingsHeader(3);
break;
case 9:
case FELICITY_BANK_STORE_RECEIPT:
sFelicityBankWork->fallbackState = 1;
gFormatData_202DE30 = sFelicityBankWork->chosenAmount;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_DEPOSIT__RECEIPT], 0, sFelicityBankWork->unkA4, 0x10D);
break;
case 10:
case FELICITY_BANK_TAKE:
if (gTeamInventoryRef->teamMoney >= MAX_TEAM_MONEY) {
sFelicityBankWork->fallbackState = 1;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_WITHDRAW__WALLET_FULL], 0, sFelicityBankWork->unkA4, 0x10D);
@ -233,12 +245,12 @@ static void UpdateFelicityBankDialogue(void)
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_WITHDRAW__NO_MONEY], 0, sFelicityBankWork->unkA4, 0x10D);
}
else {
sFelicityBankWork->fallbackState = 11;
sFelicityBankWork->fallbackState = FELICITY_BANK_TAKE_HOW_MUCH;
gFormatData_202DE30 = gTeamInventoryRef->teamSavings;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_WITHDRAW__HOW_MUCH], 0, sFelicityBankWork->unkA4, 0x10D);
}
break;
case 11:
case FELICITY_BANK_TAKE_HOW_MUCH:
sFelicityBankWork->unk64.unkC = MAX_TEAM_MONEY - gTeamInventoryRef->teamMoney;
if (sFelicityBankWork->unk64.unkC > gTeamInventoryRef->teamSavings)
sFelicityBankWork->unk64.unkC = gTeamInventoryRef->teamSavings;
@ -256,7 +268,7 @@ static void UpdateFelicityBankDialogue(void)
case 2:
CreateFelicityMoneySavingsHeader(3);
break;
case 12:
case FELICITY_BANK_TAKE_DEPOSIT:
sFelicityBankWork->fallbackState = 1;
gFormatData_202DE30 = sFelicityBankWork->chosenAmount;
xxx_info_box_80141B4(gCommonFelicity[sFelicityBankWork->mode][FEL_DLG_WITHDRAW__RECEIPT], 0, sFelicityBankWork->unkA4, 0x10D);
@ -304,7 +316,7 @@ static void CreateFelicityBankShopMenu(void)
}
}
static void sub_80169BC(void)
static void HandleFelicityBankShopMenu(void)
{
s32 menuAction;
@ -314,13 +326,13 @@ static void sub_80169BC(void)
sFelicityBankWork->menuAction = menuAction;
switch (menuAction) {
case STORE_ACTION:
UpdateFelicityBankState(7);
UpdateFelicityBankState(FELICITY_BANK_STORE);
break;
case TAKE_ACTION:
UpdateFelicityBankState(10);
UpdateFelicityBankState(FELICITY_BANK_TAKE);
break;
case INFO_ACTION:
UpdateFelicityBankState(3);
UpdateFelicityBankState(FELICITY_BANK_INFO);
break;
case CANCEL_ACTION:
UpdateFelicityBankState(4);
@ -339,7 +351,7 @@ static void Felicity_DepositMoney(void)
gTeamInventoryRef->teamSavings += sFelicityBankWork->chosenAmount;
gTeamInventoryRef->teamMoney -= sFelicityBankWork->chosenAmount;
PlaySound(332);
UpdateFelicityBankState(9);
UpdateFelicityBankState(FELICITY_BANK_STORE_RECEIPT);
break;
case 2:
UpdateFelicityBankState(5);
@ -360,7 +372,7 @@ static void Felicity_WithdrawMoney(void)
gTeamInventoryRef->teamMoney += sFelicityBankWork->chosenAmount;
gTeamInventoryRef->teamSavings -= sFelicityBankWork->chosenAmount;
PlaySound(332);
UpdateFelicityBankState(12);
UpdateFelicityBankState(FELICITY_BANK_TAKE_DEPOSIT);
break;
case 2:
UpdateFelicityBankState(5);

View File

@ -21,15 +21,15 @@ static void UpdateKangaskhanStorage2State(u32);
static void sub_8017F28(void);
static void sub_8018100(void);
static void sub_8018280(void);
static void sub_80182E4(void);
static void sub_801841C(void);
static void sub_80184D4(void);
static void sub_8018588(void);
static void BuildKangaskhanStorage2MainMenu(void);
static void BuildKangaskhanStorage2StoreMenu(void);
static void BuildKangaskhanStorage2TakeMenu(void);
static void HandleKangaskhanStorage2MainMenu(void);
static void sub_8018620(void);
static void sub_80186F8(void);
static void sub_8018854(void);
static void sub_8018904(void);
static void sub_80189C8(void);
static void HandleKangaskhanStorage2StoreMenu(void);
static void HandleKangaskhanStorage2TakeMenu(void);
static void sub_8018AC8(void);
static void sub_8018AE4(void);
@ -59,14 +59,14 @@ u32 sub_8017E54(void)
UpdateKangaskhanStorage2State(KANGASKHAN_STORAGE_2_MAIN);
break;
case KANGASKHAN_STORAGE_2_MAIN:
sub_8018588();
HandleKangaskhanStorage2MainMenu();
break;
case 4:
case 5:
sub_8018620();
break;
case 6:
sub_8018904();
HandleKangaskhanStorage2StoreMenu();
break;
case 7:
sub_8018AC8();
@ -79,7 +79,7 @@ u32 sub_8017E54(void)
sub_8018854();
break;
case 13:
sub_80189C8();
HandleKangaskhanStorage2TakeMenu();
break;
case 14:
sub_8018AE4();
@ -116,7 +116,7 @@ static void sub_8017F28(void)
sUnknown_203B20C->unkF0[0] = sUnknown_80DB7B8;
sUnknown_203B20C->unkF0[1] = sUnknown_80DB7B8;
sUnknown_203B20C->unkF0[0] = sUnknown_80DB7B8;
sub_80182E4();
BuildKangaskhanStorage2MainMenu();
sUnknown_203B20C->unkF0[2] = sUnknown_80DB7D0;
sub_8012CAC(&sUnknown_203B20C->unkF0[2], sUnknown_203B20C->unk20);
break;
@ -165,7 +165,7 @@ static void sub_8018100(void)
break;
case 6:
sub_801A9E0();
sub_801841C();
BuildKangaskhanStorage2StoreMenu();
sub_8012D60(&sUnknown_203B20C->unk70, sUnknown_203B20C->unk20, 0, sUnknown_203B20C->unk60, sUnknown_203B20C->menuAction2, 2);
break;
case 7:
@ -199,7 +199,7 @@ static void sub_8018100(void)
case 13:
sub_801CCD8();
sub_801AD34(0);
sub_80184D4();
BuildKangaskhanStorage2TakeMenu();
sub_8012D60(&sUnknown_203B20C->unk70, sUnknown_203B20C->unk20, 0, sUnknown_203B20C->unk60, sUnknown_203B20C->menuAction3, 2);
break;
case 14:
@ -223,7 +223,7 @@ static void sub_8018280(void)
sub_8012EA4(&sUnknown_203B20C->unk70, 0);
}
static void sub_80182E4(void)
static void BuildKangaskhanStorage2MainMenu(void)
{
int index;
s32 loopMax;
@ -266,7 +266,7 @@ static void sub_80182E4(void)
}
}
static void sub_801841C(void)
static void BuildKangaskhanStorage2StoreMenu(void)
{
s32 index;
s32 loopMax;
@ -301,7 +301,7 @@ static void sub_801841C(void)
}
}
static void sub_80184D4(void)
static void BuildKangaskhanStorage2TakeMenu(void)
{
s32 index;
s32 loopMax;
@ -337,7 +337,7 @@ static void sub_80184D4(void)
}
}
static void sub_8018588(void)
static void HandleKangaskhanStorage2MainMenu(void)
{
s32 menuAction;
menuAction = 0;
@ -507,7 +507,7 @@ static void sub_8018854(void)
}
}
static void sub_8018904(void)
static void HandleKangaskhanStorage2StoreMenu(void)
{
s32 menuAction;
@ -553,7 +553,7 @@ static void sub_8018904(void)
}
}
static void sub_80189C8(void)
static void HandleKangaskhanStorage2TakeMenu(void)
{
BulkItem item;
s32 menuAction;

View File

@ -22,7 +22,7 @@ static void sub_8021820(void);
static void sub_8021878(void);
static void PopulateWigglytuffShopFriendAreaInfoScreen(void);
static void sub_8021A60(void);
static s32 sub_8021B58(s16 species);
static s32 CheckSpeciesinWigglytuffFriendArea(s16 species);
bool8 CreateWigglytuffShopFriendAreaMenu(u8 friendArea, bool8 a1, s32 a2)
{
@ -132,7 +132,7 @@ static void PopulateWigglytuffShopFriendAreaInfoScreen(void)
static void sub_8021A60(void)
{
s32 sVar4;
s32 areaIndex;
s32 iVar6;
s32 index;
PokemonStruct1 *pokeStruct;
@ -158,9 +158,9 @@ static void sub_8021A60(void)
if (!sub_8098134(index))
continue;
sVar4 = sub_8021B58(index);
if (sVar4 != -1)
sWigglytuffShop2Work->pokemonStatus[sVar4] = POKEMON_SEEN;
areaIndex = CheckSpeciesinWigglytuffFriendArea(index);
if (areaIndex != -1)
sWigglytuffShop2Work->pokemonStatus[areaIndex] = POKEMON_SEEN;
}
for (index = 0; index < NUM_MONSTERS; index++) {
@ -168,13 +168,14 @@ static void sub_8021A60(void)
if (!((u8)pokeStruct->unk0 & 1))
continue;
sVar4 = sub_8021B58(pokeStruct->speciesNum);
if (sVar4 != -1)
sWigglytuffShop2Work->pokemonStatus[sVar4] = POKEMON_RECRUITED;
areaIndex = CheckSpeciesinWigglytuffFriendArea(pokeStruct->speciesNum);
if (areaIndex != -1)
sWigglytuffShop2Work->pokemonStatus[areaIndex] = POKEMON_RECRUITED;
}
}
static s32 sub_8021B58(s16 species)
/* Return index of pokemon if in the friend area, else return -1 */
static s32 CheckSpeciesinWigglytuffFriendArea(s16 species)
{
s32 baseSpecies;
s32 i;

View File

@ -43,9 +43,9 @@ static void SetWigglytuffState(s32 newState);
static void UpdateWigglytuffDialogue(void);
static void sub_8021D5C(void);
static void sub_80222C8(void);
static void BuildWigglytuffMainMenu(void);
static void sub_8022380(void);
static void sub_8022460(void);
static void HandleWigglytuffMainMenu(void);
static void sub_8022538(void);
static void sub_80225C8(void);
static void sub_8022668(void);
@ -93,7 +93,7 @@ u32 sub_8021C5C(void)
switch (sWigglytuffShop3Work->state) {
case WIGGLYTUFF_INIT:
case WIGGLYTUFF_MAIN_MENU:
sub_8022460();
HandleWigglytuffMainMenu();
break;
case WIGGLYTUFF_UNK9:
case WIGGLYTUFF_UNKA:
@ -176,11 +176,11 @@ static void UpdateWigglytuffDialogue(void)
switch (sWigglytuffShop3Work->state) {
case WIGGLYTUFF_INIT:
sub_80222C8();
BuildWigglytuffMainMenu();
sub_8014248(gCommonWigglytuff[sWigglytuffShop3Work->mode][WIGGLY_DLG_00], 0, sWigglytuffShop3Work->menuAction1, sWigglytuffShop3Work->unk1C, sWigglytuffShop3Work->unk5C, 4, 0, sWigglytuffShop3Work->unkCC, 12);
break;
case WIGGLYTUFF_MAIN_MENU:
sub_80222C8();
BuildWigglytuffMainMenu();
sub_8014248(gCommonWigglytuff[sWigglytuffShop3Work->mode][WIGGLY_DLG_01], 0, sWigglytuffShop3Work->menuAction1, sWigglytuffShop3Work->unk1C, sWigglytuffShop3Work->unk5C, 4, 0, sWigglytuffShop3Work->unkCC, 12);
break;
case FRIEND_AREA_SELECT_BUY:
@ -328,7 +328,7 @@ static void UpdateWigglytuffDialogue(void)
}
}
static void sub_80222C8(void)
static void BuildWigglytuffMainMenu(void)
{
s32 i;
s32 index = 0;
@ -416,7 +416,7 @@ static void CreateWigglytuffConfirmFriendAreaMenu(void)
sWigglytuffShop3Work->unk1C[index].menuAction = CANCEL_ACTION;
}
static void sub_8022460(void)
static void HandleWigglytuffMainMenu(void)
{
s32 menuAction;

View File

@ -88,18 +88,19 @@ ALIGNED(4) const u8 gUnknown_80E0A0C[] = _(
" ...Uh{COMMA} no?\n"
"You don{APOSTROPHE}t have any {COLOR_1 LIGHT_BLUE}A-OK Mail{END_COLOR_TEXT_1}.");
extern void sub_8031300(void);
extern void sub_803136C(void);
extern void sub_80313D8(u32);
extern void sub_8031498(void);
extern void sub_80310FC();
extern void sub_8031258();
static void sub_8031300(void);
static void HandleWonderMail6MainMenu(void);
static void HandleWonderMail6DeleteMailMenu(u32);
static void sub_8031498(void);
static void sub_80310FC();
static void sub_8031258();
enum States {
INIT_STATE = 0,
DELETE_SINGLE_MAIL_STATE = 2,
DELETE_ALL_MAIL_STATE = 3,
INFO_STATE = 4,
INIT_STATE,
MAIN_MENU,
DELETE_SINGLE_MAIL_STATE,
DELETE_ALL_MAIL_STATE,
INFO_STATE,
};
bool8 sub_8030F58(u32 wonderMailType)
@ -150,12 +151,12 @@ s32 sub_8031050(void)
case INIT_STATE:
sub_8031300();
break;
case 1:
sub_803136C();
case MAIN_MENU:
HandleWonderMail6MainMenu();
break;
case DELETE_SINGLE_MAIL_STATE:
case DELETE_ALL_MAIL_STATE:
sub_80313D8(gUnknown_203B328->state);
HandleWonderMail6DeleteMailMenu(gUnknown_203B328->state);
break;
case INFO_STATE:
sub_8031498();
@ -184,7 +185,7 @@ void sub_80310E4(u32 newState)
sub_8031258();
}
void sub_80310FC(void)
static void sub_80310FC(void)
{
RestoreUnkTextStruct_8006518(gUnknown_203B328->unkA8);
switch(gUnknown_203B328->state)
@ -194,7 +195,7 @@ void sub_80310FC(void)
gUnknown_203B328->unkA8[2] = gUnknown_80E0990;
gUnknown_203B328->unkA8[3] = gUnknown_80E0990;
break;
case 1:
case MAIN_MENU:
gUnknown_203B328->unkA8[1] = gUnknown_80E09A8;
gUnknown_203B328->unkA8[2] = gUnknown_80E0990;
gUnknown_203B328->unkA8[3] = gUnknown_80E0990;
@ -222,14 +223,14 @@ void sub_80310FC(void)
xxx_call_save_unk_text_struct_800641C(gUnknown_203B328->unkA8, TRUE, TRUE);
}
void sub_8031258(void)
static void sub_8031258(void)
{
switch(gUnknown_203B328->state)
{
case INIT_STATE:
sub_8030810(1);
break;
case 1:
case MAIN_MENU:
sub_803092C();
sub_8012D60(&gUnknown_203B328->unk8, gUnknown_80E0968, NULL, NULL, DELETE_ACTION, 1);
break;
@ -249,13 +250,13 @@ void sub_8031258(void)
}
}
void sub_8031300(void)
static void sub_8031300(void)
{
switch(sub_8030768(1))
{
case 3:
gUnknown_203B328->mailIndex = sub_80307EC();
sub_80310E4(1);
sub_80310E4(MAIN_MENU);
break;
case 4:
gUnknown_203B328->mailIndex = sub_80307EC();
@ -270,13 +271,13 @@ void sub_8031300(void)
}
}
void sub_803136C(void)
static void HandleWonderMail6MainMenu(void)
{
s32 menuAction;
menuAction = 0;
sub_8030768(0);
if (sub_8012FD8(&gUnknown_203B328->unk8) == '\0') {
if (!sub_8012FD8(&gUnknown_203B328->unk8)) {
sub_8013114(&gUnknown_203B328->unk8,&menuAction);
}
@ -298,7 +299,7 @@ void sub_803136C(void)
}
}
void sub_80313D8(u32 state)
static void HandleWonderMail6DeleteMailMenu(u32 state)
{
s32 index;
s32 menuAction;
@ -307,7 +308,7 @@ void sub_80313D8(u32 state)
menuAction = 0;
sub_8030768(0);
sub_8012FD8(&gUnknown_203B328->unk8);
if (sub_8012FD8(&gUnknown_203B328->unk58) == 0) {
if (!sub_8012FD8(&gUnknown_203B328->unk58)) {
sub_8013114(&gUnknown_203B328->unk58,&menuAction);
}
@ -345,7 +346,7 @@ void sub_80313D8(u32 state)
}
}
void sub_8031498(void)
static void sub_8031498(void)
{
switch(sub_8030DA0())
{