From 9553ec1d2863ee4c0fae213d84b06f92f7ffb629 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 7 Oct 2019 10:34:12 -0400 Subject: [PATCH] Document mevent.inc --- data/scripts/cable_club.inc | 4 ++-- data/scripts/mevent.inc | 39 ++++++++++++++++++------------------- data/text/mevent.inc | 16 +++++++-------- src/easy_chat.c | 28 +++++++++++++------------- 4 files changed, 43 insertions(+), 44 deletions(-) diff --git a/data/scripts/cable_club.inc b/data/scripts/cable_club.inc index 3fcb25807..d13e58313 100644 --- a/data/scripts/cable_club.inc +++ b/data/scripts/cable_club.inc @@ -55,11 +55,11 @@ OldaleTown_PokemonCenter_2F_EventScript_276B23:: @ 8276B23 compare VAR_RESULT, 1 goto_if_eq OldaleTown_PokemonCenter_2F_EventScript_276B19 goto_if_set FLAG_SYS_HAS_EON_TICKET, OldaleTown_PokemonCenter_2F_EventScript_276B19 - msgbox gUnknown_08273594, MSGBOX_DEFAULT + msgbox Mevent_Text_TheresATicketForYou, MSGBOX_DEFAULT giveitem_std ITEM_EON_TICKET setflag FLAG_SYS_HAS_EON_TICKET setvar VAR_ALWAYS_ZERO_0x403F, 0 - msgbox gUnknown_082735F2, MSGBOX_DEFAULT + msgbox Mevent_Text_TryUsingItAtLilycovePort, MSGBOX_DEFAULT release end diff --git a/data/scripts/mevent.inc b/data/scripts/mevent.inc index 29f9c47d5..88f44e002 100644 --- a/data/scripts/mevent.inc +++ b/data/scripts/mevent.inc @@ -1,27 +1,26 @@ - EventScript_Questionnaire:: @ 827381B lockall - msgbox gText_FillOutQuestionnaire, MSGBOX_YESNO + msgbox Mevent_Text_FillOutQuestionnaire, MSGBOX_YESNO compare VAR_RESULT, 0 - goto_if_eq EventScript_2738FD + goto_if_eq Mevent_EventScript_Release setvar VAR_0x8004, EASY_CHAT_TYPE_QUESTIONNAIRE call Common_ShowEasyChatScreen lock faceplayer specialvar VAR_0x8008, GetMartEmployeeObjectEventId compare VAR_0x8004, 1 - goto_if_eq EventScript_27386D + goto_if_eq Mevent_EventScript_PlayerInputMysteryEventPhrase compare VAR_0x8004, 2 - goto_if_eq EventScript_2738B5 + goto_if_eq Mevent_EventScript_PlayerInputMysteryGiftPhrase compare VAR_RESULT, 0 - goto_if_eq EventScript_2738FD + goto_if_eq Mevent_EventScript_Release compare VAR_RESULT, 1 - goto_if_eq EventScript_2738FF + goto_if_eq Mevent_EventScript_QuestionnaireThankYou end -EventScript_27386D:: @ 827386D - goto_if_unset FLAG_SYS_POKEDEX_GET, EventScript_2738FF - goto_if_set FLAG_SYS_MYSTERY_EVENT_ENABLE, EventScript_2738FF +Mevent_EventScript_PlayerInputMysteryEventPhrase:: @ 827386D + goto_if_unset FLAG_SYS_POKEDEX_GET, Mevent_EventScript_QuestionnaireThankYou + goto_if_set FLAG_SYS_MYSTERY_EVENT_ENABLE, Mevent_EventScript_QuestionnaireThankYou applymovement VAR_0x8008, Common_Movement_FaceDown waitmovement 0 playse SE_PIN @@ -29,15 +28,15 @@ EventScript_27386D:: @ 827386D waitmovement 0 applymovement VAR_0x8008, Common_Movement_Delay48 waitmovement 0 - msgbox gUnknown_08273506, MSGBOX_DEFAULT + msgbox Mevent_Text_YouKnowThoseWordsEvent, MSGBOX_DEFAULT setflag FLAG_SYS_MYSTERY_EVENT_ENABLE - msgbox gUnknown_08273559, MSGBOX_DEFAULT + msgbox Mevent_Text_YouCanAccessMysteryEvent, MSGBOX_DEFAULT releaseall end -EventScript_2738B5:: @ 82738B5 - goto_if_unset FLAG_SYS_POKEDEX_GET, EventScript_2738FF - goto_if_set FLAG_SYS_MYSTERY_GIFT_ENABLE, EventScript_2738FF +Mevent_EventScript_PlayerInputMysteryGiftPhrase:: @ 82738B5 + goto_if_unset FLAG_SYS_POKEDEX_GET, Mevent_EventScript_QuestionnaireThankYou + goto_if_set FLAG_SYS_MYSTERY_GIFT_ENABLE, Mevent_EventScript_QuestionnaireThankYou applymovement VAR_0x8008, Common_Movement_FaceDown waitmovement 0 playse SE_PIN @@ -45,19 +44,19 @@ EventScript_2738B5:: @ 82738B5 waitmovement 0 applymovement VAR_0x8008, Common_Movement_Delay48 waitmovement 0 - msgbox gUnknown_08273446, MSGBOX_DEFAULT + msgbox Mevent_Text_YouKnowThoseWordsGift, MSGBOX_DEFAULT setflag FLAG_SYS_MYSTERY_GIFT_ENABLE - msgbox gUnknown_082734CC, MSGBOX_DEFAULT + msgbox Mevent_Text_YouCanAccessMysteryGift, MSGBOX_DEFAULT releaseall end -EventScript_2738FD:: @ 82738FD +Mevent_EventScript_Release:: @ 82738FD releaseall end -EventScript_2738FF:: @ 82738FF +Mevent_EventScript_QuestionnaireThankYou:: @ 82738FF applymovement VAR_0x8008, Common_Movement_FaceDown waitmovement 0 - msgbox gText_ThankYouForTakingQuestionnaire, MSGBOX_DEFAULT + msgbox Mevent_Text_QuestionnaireThankYou, MSGBOX_DEFAULT releaseall end diff --git a/data/text/mevent.inc b/data/text/mevent.inc index 44c456f1c..ae4032eb4 100644 --- a/data/text/mevent.inc +++ b/data/text/mevent.inc @@ -1,14 +1,14 @@ -gText_FillOutQuestionnaire:: @ 827339F +Mevent_Text_FillOutQuestionnaire:: @ 827339F .string "There is a questionnaire.\n" .string "Would you like to fill it out?$" -gText_ThankYouForTakingQuestionnaire:: @ 82733D8 +Mevent_Text_QuestionnaireThankYou:: @ 82733D8 .string "Thank you for taking the time to\n" .string "fill out our questionnaire.\p" .string "Your feedback will be used for\n" .string "future reference.$" -gUnknown_08273446:: @ 8273446 +Mevent_Text_YouKnowThoseWordsGift:: @ 8273446 .string "Oh, hello!\n" .string "You know those words?\p" .string "That means you must know about\n" @@ -16,27 +16,27 @@ gUnknown_08273446:: @ 8273446 .string "From now on, you should be\n" .string "receiving MYSTERY GIFTS!$" -gUnknown_082734CC:: @ 82734CC +Mevent_Text_YouCanAccessMysteryGift:: @ 82734CC .string "Once you save your game, you can\n" .string "access the MYSTERY GIFT.$" -gUnknown_08273506:: @ 8273506 +Mevent_Text_YouKnowThoseWordsEvent:: @ 8273506 .string "Oh, hello!\n" .string "You know those words?\p" .string "That means you must know about\n" .string "the MYSTERY EVENT.$" -gUnknown_08273559:: @ 8273559 +Mevent_Text_YouCanAccessMysteryEvent:: @ 8273559 .string "Once you save your game, you can\n" .string "access the MYSTERY EVENT.$" -gUnknown_08273594:: @ 8273594 +Mevent_Text_TheresATicketForYou:: @ 8273594 .string "Thank you for using the MYSTERY\n" .string "EVENT System.\p" .string "You must be {PLAYER}.\n" .string "There is a ticket here for you.$" -gUnknown_082735F2:: @ 82735F2 +Mevent_Text_TryUsingItAtLilycovePort:: @ 82735F2 .string "It appears to be for use at\n" .string "the LILYCOVE CITY port.\p" .string "Why not give it a try and see what\n" diff --git a/src/easy_chat.c b/src/easy_chat.c index 54504a539..827b47085 100644 --- a/src/easy_chat.c +++ b/src/easy_chat.c @@ -121,8 +121,8 @@ static void sub_811B768(void); static u8 sub_811B960(u8); static void sub_811B9A0(void); static u8 sub_811BA1C(void); -static int sub_811BF20(void); -static u16 sub_811BF40(void); +static int DidPlayerInputMysteryGiftPhrase(void); +static u16 DidPlayerInputABerryMasterWifePhrase(void); static bool8 sub_811CE94(void); static void sub_811CF64(void); static void sub_811CF04(void); @@ -2597,17 +2597,17 @@ static int FooterHasFourOptions_(void) return FooterHasFourOptions(); } -u8 sub_811BC7C(const u16 *arg0, u8 arg1) +static bool8 IsPhraseDifferentThanPlayerInput(const u16 *phrase, u8 phraseLength) { u8 i; - for (i = 0; i < arg1; i++) + for (i = 0; i < phraseLength; i++) { - if (arg0[i] != sEasyChatScreen->ecWordBuffer[i]) - return 1; + if (phrase[i] != sEasyChatScreen->ecWordBuffer[i]) + return TRUE; } - return 0; + return FALSE; } static u8 GetDisplayedPersonType(void) @@ -2730,7 +2730,7 @@ static void sub_811BE9C(void) FlagSet(FLAG_SYS_CHAT_USED); break; case EASY_CHAT_TYPE_QUESTIONNAIRE: - if (sub_811BF20()) + if (DidPlayerInputMysteryGiftPhrase()) gSpecialVar_0x8004 = 2; else gSpecialVar_0x8004 = 0; @@ -2740,22 +2740,22 @@ static void sub_811BE9C(void) gSpecialVar_0x8004 = sub_81226D8(sEasyChatScreen->ecWordBuffer); break; case EASY_CHAT_TYPE_GOOD_SAYING: - gSpecialVar_0x8004 = sub_811BF40(); + gSpecialVar_0x8004 = DidPlayerInputABerryMasterWifePhrase(); break; } } -static int sub_811BF20(void) +static int DidPlayerInputMysteryGiftPhrase(void) { - return sub_811BC7C(sMysteryGiftPhrase, ARRAY_COUNT(sMysteryGiftPhrase)) == 0; + return !IsPhraseDifferentThanPlayerInput(sMysteryGiftPhrase, ARRAY_COUNT(sMysteryGiftPhrase)); } -static u16 sub_811BF40(void) +static u16 DidPlayerInputABerryMasterWifePhrase(void) { int i; - for (i = 0; i < 5; i++) + for (i = 0; i < (int)ARRAY_COUNT(sBerryMasterWifePhrases); i++) { - if (!sub_811BC7C(sBerryMasterWifePhrases[i], ARRAY_COUNT(*sBerryMasterWifePhrases))) + if (!IsPhraseDifferentThanPlayerInput(sBerryMasterWifePhrases[i], ARRAY_COUNT(*sBerryMasterWifePhrases))) return i + 1; }