From 95406384f4b8291238a4822ad0bf20a9b491df72 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 14 Oct 2021 12:12:16 -0400 Subject: Start wonder card/news documenting --- include/constants/global.h | 2 ++ include/constants/mevent.h | 3 +++ include/global.h | 18 +++++++++--------- include/mevent_801BAAC.h | 16 ---------------- include/wonder_transfer.h | 24 ++++++++++++++++++++++++ 5 files changed, 38 insertions(+), 25 deletions(-) delete mode 100644 include/mevent_801BAAC.h create mode 100644 include/wonder_transfer.h (limited to 'include') diff --git a/include/constants/global.h b/include/constants/global.h index 1cece7975..518fe6bad 100644 --- a/include/constants/global.h +++ b/include/constants/global.h @@ -87,6 +87,8 @@ #define MOVE_NAME_LENGTH 12 #define NUM_QUESTIONNAIRE_WORDS 4 #define QUIZ_QUESTION_LEN 9 +#define WONDER_CARD_TEXT_LENGTH 40 +#define WONDER_NEWS_TEXT_LENGTH 40 #define MALE 0 #define FEMALE 1 diff --git a/include/constants/mevent.h b/include/constants/mevent.h index 25bbcdf36..3478816fd 100644 --- a/include/constants/mevent.h +++ b/include/constants/mevent.h @@ -12,4 +12,7 @@ #define REQUIRED_CARD_BATTLES 3 +// Number of different types/colors of Wonder Card and News backgrounds +#define NUM_WONDER_BGS 8 + #endif //GUARD_MEVENT_H diff --git a/include/global.h b/include/global.h index d14aa60f4..f8bb24da7 100644 --- a/include/global.h +++ b/include/global.h @@ -849,9 +849,9 @@ struct MysteryEventStruct { u16 unk_00; u8 unk_02; - u8 unk_03; - u8 unk_04[40]; - u8 unk_2C[10][40]; + u8 bgType; + u8 unk_04[WONDER_NEWS_TEXT_LENGTH]; + u8 unk_2C[10][WONDER_NEWS_TEXT_LENGTH]; }; struct WonderNewsSaveStruct @@ -866,14 +866,14 @@ struct MysteryEventStruct u16 unk_02; u32 unk_04; u8 unk_08_0:2; - u8 unk_08_2:4; + u8 bgType:4; u8 unk_08_6:2; u8 unk_09; - u8 unk_0A[40]; - u8 unk_32[40]; - u8 unk_5A[4][40]; - u8 unk_FA[40]; - u8 unk_122[40]; + u8 unk_0A[WONDER_CARD_TEXT_LENGTH]; + u8 unk_32[WONDER_CARD_TEXT_LENGTH]; + u8 unk_5A[4][WONDER_CARD_TEXT_LENGTH]; + u8 unk_FA[WONDER_CARD_TEXT_LENGTH]; + u8 unk_122[WONDER_CARD_TEXT_LENGTH]; }; struct WonderCardSaveStruct diff --git a/include/mevent_801BAAC.h b/include/mevent_801BAAC.h deleted file mode 100644 index d76bc92c2..000000000 --- a/include/mevent_801BAAC.h +++ /dev/null @@ -1,16 +0,0 @@ -#ifndef GUARD_MEVENT_801BAAC_H -#define GUARD_MEVENT_801BAAC_H - -bool32 InitWonderCardResources(struct WonderCard * r5, struct MEventBuffer_3430_Sub * r6); -bool32 InitWonderNewsResources(const struct WonderNews * a0); -s32 FadeToWonderCardMenu(void); -s32 FadeToWonderNewsMenu(void); -s32 FadeOutFromWonderCard(bool32 flag); -void DestroyWonderCardResources(void); -s32 FadeOutFromWonderNews(bool32 flag); -void DestroyWonderNewsResources(void); -u32 MENews_GetInput(u16 input); -void MENews_AddScrollIndicatorArrowPair(void); -void MENews_RemoveScrollIndicatorArrowPair(void); - -#endif //GUARD_MEVENT_801BAAC_H diff --git a/include/wonder_transfer.h b/include/wonder_transfer.h new file mode 100644 index 000000000..65b475725 --- /dev/null +++ b/include/wonder_transfer.h @@ -0,0 +1,24 @@ +#ifndef GUARD_WONDER_TRANSFER_H +#define GUARD_WONDER_TRANSFER_H + +enum { + NEWS_INPUT_A, + NEWS_INPUT_B, + NEWS_INPUT_SCROLL_UP, + NEWS_INPUT_SCROLL_DOWN, + NEWS_INPUT_NONE = 0xFF +}; + +bool32 WonderCard_Init(struct WonderCard * card, struct MEventBuffer_3430_Sub * r6); +bool32 WonderNews_Init(const struct WonderNews * news); +s32 WonderCard_Enter(void); +s32 WonderNews_Enter(void); +s32 WonderCard_Exit(bool32 flag); +s32 WonderNews_Exit(bool32 flag); +void WonderCard_Destroy(void); +void WonderNews_Destroy(void); +u32 WonderNews_GetInput(u16 input); +void WonderNews_AddScrollIndicatorArrowPair(void); +void WonderNews_RemoveScrollIndicatorArrowPair(void); + +#endif //GUARD_WONDER_TRANSFER_H -- cgit v1.2.3 From 37e52c4f34fa3d6bb25f670bfc77ed220962f834 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 14 Oct 2021 14:10:42 -0400 Subject: Document some mystery gift --- include/ereader_screen.h | 2 +- include/mystery_gift.h | 8 ++++---- include/union_room.h | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) (limited to 'include') diff --git a/include/ereader_screen.h b/include/ereader_screen.h index 1daea4be0..a6ac65b17 100755 --- a/include/ereader_screen.h +++ b/include/ereader_screen.h @@ -1,6 +1,6 @@ #ifndef GUARD_EREADER_SCREEN_H #define GUARD_EREADER_SCREEN_H -void task_add_00_ereader(void); +void CreateEReaderTask(void); #endif // GUARD_EREADER_SCREEN_H diff --git a/include/mystery_gift.h b/include/mystery_gift.h index fb0414ee0..42c7f47ba 100644 --- a/include/mystery_gift.h +++ b/include/mystery_gift.h @@ -4,15 +4,15 @@ extern bool8 gGiftIsFromEReader; u16 GetMysteryGiftBaseBlock(void); -void c2_mystery_gift_e_reader_run(void); +void CB2_MysteryGiftEReader(void); void PrintMysteryGiftOrEReaderTopMenu(bool8 isJapanese, bool32 usePickOkCancel); void MG_DrawCheckerboardPattern(u32 bg); void MainCB_FreeAllBuffersAndReturnToInitTitleScreen(void); bool32 MG_PrintTextOnWindow1AndWaitButton(u8 *textState, const u8 *str); void AddTextPrinterToWindow1(const u8 *src); -void c2_ereader(void); -void c2_mystery_gift(void); +void CB2_InitEReader(void); +void CB2_InitMysteryGift(void); void MG_DrawTextBorder(u8 windowId); -s8 mevent_message_print_and_prompt_yes_no(u8 *textState, u16 *windowId, bool8 yesNoBoxPlacement, const u8 *str); +s8 DoMysteryGiftYesNo(u8 *textState, u16 *windowId, bool8 yesNoBoxPlacement, const u8 *str); #endif //GUARD_MYSTERY_GIFT_H diff --git a/include/union_room.h b/include/union_room.h index b364e7559..acff4b592 100644 --- a/include/union_room.h +++ b/include/union_room.h @@ -153,9 +153,9 @@ extern u8 gUnionRoomRequestedMonType; u8 CreateTask_CreateTradeMenu(void); void SetUsingUnionRoomStartMenu(void); -void MEvent_CreateTask_CardOrNewsWithFriend(u32 activity); -void MEvent_CreateTask_CardOrNewsOverWireless(u32 activity); -void MEvent_CreateTask_Leader(u32 activity); +void CreateTask_LinkMysteryGiftWithFriend(u32 activity); +void CreateTask_LinkMysteryGiftOverWireless(u32 activity); +void CreateTask_SendMysteryGift(u32 activity); u8 CreateTask_ListenToWireless(void); void StartUnionRoomBattle(u16 battleFlags); -- cgit v1.2.3 From c02001c46d4ea55db8b59f91413627800d5674e8 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 14 Oct 2021 15:36:51 -0400 Subject: Document mystery gift link scripts, general mystery gift --- include/constants/flags.h | 35 ++++++++++++------------ include/global.h | 41 +++++++++------------------- include/mevent.h | 30 ++++++++++----------- include/mevent_client.h | 59 +++++++++++++++++++++++++++++++++-------- include/mevent_server.h | 2 +- include/mevent_server_helpers.h | 16 +++++------ include/mystery_event_script.h | 4 +-- include/wonder_transfer.h | 2 +- 8 files changed, 106 insertions(+), 83 deletions(-) (limited to 'include') diff --git a/include/constants/flags.h b/include/constants/flags.h index ef5a9a75e..880d227aa 100644 --- a/include/constants/flags.h +++ b/include/constants/flags.h @@ -338,23 +338,24 @@ #define FLAG_RECEIVED_AURORA_TICKET 0x13A #define FLAG_RECEIVED_MYSTIC_TICKET 0x13B #define FLAG_RECEIVED_OLD_SEA_MAP 0x13C -#define FLAG_UNUSED_MYSTERY_GIFT_0x13D 0x13D -#define FLAG_UNUSED_MYSTERY_GIFT_0x13E 0x13E -#define FLAG_UNUSED_MYSTERY_GIFT_0x13F 0x13F -#define FLAG_UNUSED_MYSTERY_GIFT_0x140 0x140 -#define FLAG_UNUSED_MYSTERY_GIFT_0x141 0x141 -#define FLAG_UNUSED_MYSTERY_GIFT_0x142 0x142 -#define FLAG_UNUSED_MYSTERY_GIFT_0x143 0x143 -#define FLAG_UNUSED_MYSTERY_GIFT_0x144 0x144 -#define FLAG_UNUSED_MYSTERY_GIFT_0x145 0x145 -#define FLAG_UNUSED_MYSTERY_GIFT_0x146 0x146 -#define FLAG_UNUSED_MYSTERY_GIFT_0x147 0x147 -#define FLAG_UNUSED_MYSTERY_GIFT_0x148 0x148 -#define FLAG_UNUSED_MYSTERY_GIFT_0x149 0x149 -#define FLAG_UNUSED_MYSTERY_GIFT_0x14A 0x14A -#define FLAG_UNUSED_MYSTERY_GIFT_0x14B 0x14B -#define FLAG_UNUSED_MYSTERY_GIFT_0x14C 0x14C -#define FLAG_UNUSED_MYSTERY_GIFT_0x14D 0x14D +#define FLAG_MYSTERY_GIFT_UNUSED_1 0x13D // These mystery gift flags are referenced but never set +#define FLAG_MYSTERY_GIFT_UNUSED_2 0x13E +#define FLAG_MYSTERY_GIFT_UNUSED_3 0x13F +#define FLAG_MYSTERY_GIFT_UNUSED_4 0x140 +#define FLAG_MYSTERY_GIFT_UNUSED_5 0x141 +#define FLAG_MYSTERY_GIFT_UNUSED_6 0x142 +#define FLAG_MYSTERY_GIFT_UNUSED_7 0x143 +#define FLAG_MYSTERY_GIFT_UNUSED_8 0x144 +#define FLAG_MYSTERY_GIFT_UNUSED_9 0x145 +#define FLAG_MYSTERY_GIFT_UNUSED_10 0x146 +#define FLAG_MYSTERY_GIFT_UNUSED_11 0x147 +#define FLAG_MYSTERY_GIFT_UNUSED_12 0x148 +#define FLAG_MYSTERY_GIFT_UNUSED_13 0x149 +#define FLAG_MYSTERY_GIFT_UNUSED_14 0x14A +#define FLAG_MYSTERY_GIFT_UNUSED_15 0x14B +#define FLAG_MYSTERY_GIFT_UNUSED_16 0x14C +#define FLAG_MYSTERY_GIFT_UNUSED_17 0x14D +#define NUM_MYSTERY_GIFT_FLAGS (1 + FLAG_MYSTERY_GIFT_UNUSED_17 - FLAG_RECEIVED_AURORA_TICKET) #define FLAG_MIRAGE_TOWER_VISIBLE 0x14E #define FLAG_CHOSE_ROOT_FOSSIL 0x14F diff --git a/include/global.h b/include/global.h index f8bb24da7..c737be7b8 100644 --- a/include/global.h +++ b/include/global.h @@ -854,15 +854,9 @@ struct MysteryEventStruct u8 unk_2C[10][WONDER_NEWS_TEXT_LENGTH]; }; - struct WonderNewsSaveStruct -{ - u32 crc; - struct WonderNews data; -}; - struct WonderCard { - u16 unk_00; + u16 flagId; u16 unk_02; u32 unk_04; u8 unk_08_0:2; @@ -876,13 +870,7 @@ struct MysteryEventStruct u8 unk_122[WONDER_CARD_TEXT_LENGTH]; }; - struct WonderCardSaveStruct -{ - u32 crc; - struct WonderCard data; -}; - - struct MEventBuffer_3430_Sub + struct MEventBuffer_3430 { u16 unk_00; u16 unk_02; @@ -891,20 +879,17 @@ struct MysteryEventStruct u16 unk_08[2][7]; }; - struct MEventBuffer_3430 -{ - u32 crc; - struct MEventBuffer_3430_Sub data; -}; - - struct MEventBuffers + struct MysteryGiftSave { - /*0x000 0x322C*/ struct WonderNewsSaveStruct wonderNews; - /*0x1c0 0x33EC*/ struct WonderCardSaveStruct wonderCard; - /*0x310 0x353C*/ struct MEventBuffer_3430 buffer_310; - /*0x338 0x3564*/ u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; - /*0x340 0x356C*/ struct MysteryEventStruct unk_340; - /*0x344 0x3570*/ u32 unk_344[2][5]; + u32 newsCrc; + struct WonderNews news; + u32 cardCrc; + struct WonderCard card; + u32 unkCrc; + struct MEventBuffer_3430 unk_3430; + u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; + struct MysteryEventStruct unk_340; + u32 unk_344[2][5]; }; // 0x36C 0x3598 // For external event data storage. The majority of these may have never been used. @@ -1031,7 +1016,7 @@ struct SaveBlock1 /*0x31C7*/ struct ExternalEventFlags externalEventFlags; /*0x31DC*/ struct Roamer roamer; /*0x31F8*/ struct EnigmaBerry enigmaBerry; - /*0x322C*/ struct MEventBuffers unk_322C; + /*0x322C*/ struct MysteryGiftSave mysteryGift; /*0x3598*/ u8 field_3598[0x180]; /*0x3718*/ u32 trainerHillTimes[4]; /*0x3728*/ struct RamScript ramScript; diff --git a/include/mevent.h b/include/mevent.h index 4b7d39b0c..4fda47fbd 100755 --- a/include/mevent.h +++ b/include/mevent.h @@ -21,30 +21,30 @@ struct MEventStruct_Unk1442CC u16 unk_0C; u32 unk_10; u16 unk_14; - u16 unk_16[NUM_QUESTIONNAIRE_WORDS]; - struct MEventBuffer_3430_Sub unk_20; + u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; + struct MEventBuffer_3430 unk_20; u8 unk_44; - u8 unk_45[7]; - u8 unk_4C[4]; - u16 unk_50[6]; - u8 unk_5C[4]; - u8 unk_60; + u8 playerName[PLAYER_NAME_LENGTH]; + u8 playerTrainerId[TRAINER_ID_LENGTH]; + u16 easyChatProfile[EASY_CHAT_BATTLE_WORDS_COUNT]; + u8 romHeaderGameCode[4]; + u8 romHeaderSoftwareVersion; }; void sub_801AFD8(void); struct WonderNews *GetSavedWonderNews(void); struct WonderCard *GetSavedWonderCard(void); -struct MEventBuffer_3430_Sub *sav1_get_mevent_buffer_2(void); +struct MEventBuffer_3430 *sav1_get_mevent_buffer_2(void); struct MysteryEventStruct *sub_801B044(void); u16 *GetQuestionnaireWordsPtr(void); -void DestroyWonderNews(void); -bool32 sub_801B078(const struct WonderNews *src); -bool32 ValidateReceivedWonderNews(void); +void ClearSavedWonderNews(void); +bool32 SaveWonderNews(const struct WonderNews *news); +bool32 ValidateSavedWonderNews(void); bool32 WonderNews_Test_Unk_02(void); bool32 sub_801B1A4(const u8 *src); -void DestroyWonderCard(void); -bool32 sub_801B21C(const struct WonderCard *data); -bool32 ValidateReceivedWonderCard(void); +void ClearSavedWonderCard(void); +bool32 SaveWonderCard(const struct WonderCard *card); +bool32 ValidateSavedWonderCard(void); bool32 WonderCard_Test_Unk_08_6(void); u16 GetWonderCardFlagID(void); void WonderCard_ResetInternalReceivedFlag(struct WonderCard *buffer); @@ -54,7 +54,7 @@ void sub_801B580(struct MEventStruct_Unk1442CC *data, bool32 a1); bool32 sub_801B6A0(const struct MEventStruct_Unk1442CC *data, bool32 a1); u32 sub_801B6EC(const u16 *a0, const struct MEventStruct_Unk1442CC *a1, const void *unused); u32 sub_801B708(const u16 *a0, const struct MEventStruct_Unk1442CC *a1, const void *unused); -bool32 MEventStruct_Unk1442CC_CompareField_unk_16(const struct MEventStruct_Unk1442CC *a0, const u16 *a1); +bool32 MysteryGift_DoesQuestionnaireMatch(const struct MEventStruct_Unk1442CC *data, const u16 *words); u16 MEventStruct_Unk1442CC_GetValueNFrom_unk_20(const struct MEventStruct_Unk1442CC *a0, u32 command); u16 mevent_081445C0(u32 command); void ResetReceivedWonderCardFlag(void); diff --git a/include/mevent_client.h b/include/mevent_client.h index c32d14d7a..f68bb7592 100644 --- a/include/mevent_client.h +++ b/include/mevent_client.h @@ -3,31 +3,68 @@ #include "mevent_server_helpers.h" -struct mevent_client_cmd +// Return values for client functions called by MysteryGiftClient_Run +enum { + CLI_RET_INIT, + CLI_RET_1, + CLI_RET_2, + CLI_RET_3, + CLI_RET_ASK_TOSS, + CLI_RET_5, + CLI_RET_END, +}; + +// IDs for client script instructions +enum { + CLI_NONE, + CLI_RETURN, + CLI_RECV, + CLI_SEND_LOADED, + CLI_COPY_RECV, + CLI_5, + CLI_COPY_RECV_IF_N, + CLI_COPY_RECV_IF, + CLI_8, + CLI_9, + CLI_10, + CLI_11, + CLI_12, + CLI_ASK_TOSS, + CLI_LOAD_TOSS_RESPONSE, + CLI_15, + CLI_16, + CLI_17, + CLI_RECV_EREADER_TRAINER, + CLI_SEND_STAT, + CLI_20, + CLI_21, +}; + +struct MysteryGiftClientCmd { u32 instr; u32 parameter; }; -struct mevent_client +struct MysteryGiftClient { u32 unk_00; u32 param; - u32 mainseqno; - u32 flag; + u32 funcId; + u32 funcState; u32 cmdidx; void * sendBuffer; void * recvBuffer; - struct mevent_client_cmd * cmdBuffer; + struct MysteryGiftClientCmd * cmdBuffer; void * buffer; - struct mevent_srv_sub manager; - u32 unk_4C; + struct MysteryGiftLink link; + bool32 isWonderNews; }; -void mevent_client_do_init(u32 arg); -u32 mevent_client_do_exec(u16 * a0); -void mevent_client_inc_flag(void); +void MysteryGiftClient_Create(bool32 isWonderNews); +u32 MysteryGiftClient_Run(u16 * param); +void MysteryGiftClient_AdvanceState(void); void * mevent_client_get_buffer(void); -void mevent_client_set_param(u32 a0); +void MysteryGiftClient_SetParam(u32 value); #endif //GUARD_MEVENT_CLIENT_H diff --git a/include/mevent_server.h b/include/mevent_server.h index e74337cf6..3152280d3 100644 --- a/include/mevent_server.h +++ b/include/mevent_server.h @@ -26,7 +26,7 @@ struct mevent_srv_common const void * sendBuffer2; u32 sendBuffer2Size; u32 sendWord; - struct mevent_srv_sub manager; + struct MysteryGiftLink manager; }; void mevent_srv_new_wcard(); diff --git a/include/mevent_server_helpers.h b/include/mevent_server_helpers.h index e4e409862..d2f292a0b 100644 --- a/include/mevent_server_helpers.h +++ b/include/mevent_server_helpers.h @@ -3,7 +3,7 @@ #define ME_SEND_BUF_SIZE 0x400 -struct mevent_srv_sub +struct MysteryGiftLink { s32 seqno; u8 sendPlayerNo; @@ -18,8 +18,8 @@ struct mevent_srv_sub u16 sendSize; void * recvBfr; const void * sendBfr; - u32 (*recvFunc)(struct mevent_srv_sub *); - u32 (*sendFunc)(struct mevent_srv_sub *); + u32 (*recvFunc)(struct MysteryGiftLink *); + u32 (*sendFunc)(struct MysteryGiftLink *); }; struct send_recv_header @@ -29,10 +29,10 @@ struct send_recv_header u16 size; }; -void mevent_srv_sub_init(struct mevent_srv_sub *, u32, u32); -void mevent_srv_sub_init_send(struct mevent_srv_sub * manager, u32 ident, const void * src, u32 size); -bool32 mevent_srv_sub_recv(struct mevent_srv_sub * manager); -bool32 mevent_srv_sub_send(struct mevent_srv_sub * manager); -void mevent_srv_sub_init_recv(struct mevent_srv_sub *, u32, void *); +void MysteryGiftLink_Init(struct MysteryGiftLink *, u32, u32); +void MysteryGiftLink_InitSend(struct MysteryGiftLink * manager, u32 ident, const void * src, u32 size); +bool32 MysteryGiftLink_Recv(struct MysteryGiftLink * manager); +bool32 MysteryGiftLink_Send(struct MysteryGiftLink * manager); +void MysteryGiftLink_InitRecv(struct MysteryGiftLink *, u32, void *); #endif //GUARD_MEVENT_SERVER_HELPERS_H diff --git a/include/mystery_event_script.h b/include/mystery_event_script.h index 991cab53a..807c78b13 100644 --- a/include/mystery_event_script.h +++ b/include/mystery_event_script.h @@ -1,8 +1,8 @@ #ifndef GUARD_MYSTERY_EVENT_SCRIPT_H #define GUARD_MYSTERY_EVENT_SCRIPT_H -void sub_8153870(u8 *script); -bool32 sub_8153884(u32 *a0); +void InitMysteryGiftScriptContext(u8 *script); +bool32 RunMysteryGiftScriptContextCommand(u32 *script); u32 RunMysteryEventScript(u8 *script); void SetMysteryEventScriptStatus(u32 val); u16 GetRecordMixingGift(void); diff --git a/include/wonder_transfer.h b/include/wonder_transfer.h index 65b475725..7532d6b3c 100644 --- a/include/wonder_transfer.h +++ b/include/wonder_transfer.h @@ -9,7 +9,7 @@ enum { NEWS_INPUT_NONE = 0xFF }; -bool32 WonderCard_Init(struct WonderCard * card, struct MEventBuffer_3430_Sub * r6); +bool32 WonderCard_Init(struct WonderCard * card, struct MEventBuffer_3430 * r6); bool32 WonderNews_Init(const struct WonderNews * news); s32 WonderCard_Enter(void); s32 WonderNews_Enter(void); -- cgit v1.2.3 From e3bb257bcf4ec855a0a45794c2838f0e2b5708f5 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Fri, 15 Oct 2021 12:05:19 -0400 Subject: Fix some trainer card link access --- include/trainer_card.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'include') diff --git a/include/trainer_card.h b/include/trainer_card.h index 685d1cdca..f5e73da83 100644 --- a/include/trainer_card.h +++ b/include/trainer_card.h @@ -44,8 +44,11 @@ struct TrainerCard /*0x28*/ u16 easyChatProfile[TRAINER_CARD_PROFILE_LENGTH]; /*0x30*/ u8 playerName[PLAYER_NAME_LENGTH + 1]; /*0x38*/ u8 version; - /*0x3A*/ bool16 hasAllFrontierSymbols; - /*0x3C*/ u32 berryCrushPoints; + /*0x3A*/ bool16 linkHasAllFrontierSymbols; + /*0x3C*/ union { + u32 berryCrush; + u32 frontier; + } linkPoints; // This field is used differently by FRLG vs Emerald /*0x40*/ u32 unionRoomNum; /*0x44*/ u8 filler[8]; /*0x4C*/ bool8 shouldDrawStickers; // FRLG only @@ -54,7 +57,9 @@ struct TrainerCard /*0x4F*/ u8 facilityClass; /*0x50*/ u8 stickers[TRAINER_CARD_STICKER_TYPES]; // FRLG only /*0x54*/ u16 monSpecies[PARTY_SIZE]; // FRLG only - /*0x60*/ bool16 hasAllSymbols; + // Note: Link players use linkHasAllFrontierSymbols, not the field below, + // which they use for a Wonder Card flag id instead (see CreateTrainerCardInBuffer) + /*0x60*/ bool16 hasAllFrontierSymbols; /*0x62*/ u16 frontierBP; }; @@ -62,9 +67,9 @@ extern struct TrainerCard gTrainerCards[4]; u32 CountPlayerTrainerStars(void); u8 GetTrainerCardStars(u8 cardId); -void CopyTrainerCardData(struct TrainerCard *dst, u16 *src, u8 gameVersion); +void CopyTrainerCardData(struct TrainerCard *dst, struct TrainerCard *src, u8 gameVersion); void ShowPlayerTrainerCard(void (*callback)(void)); void ShowTrainerCardInLink(u8 arg0, void (*callback)(void)); -void TrainerCard_GenerateCardForPlayer(struct TrainerCard *); +void TrainerCard_GenerateCardForLinkPlayer(struct TrainerCard *); #endif // GUARD_TRAINER_CARD_H -- cgit v1.2.3 From 845a5e99cc01607aae5f74c3e5e700a72734145f Mon Sep 17 00:00:00 2001 From: GriffinR Date: Fri, 15 Oct 2021 12:56:14 -0400 Subject: General mystery gift documentation, finish mystery gift client/server/scripts --- include/constants/flags.h | 68 +++++++++++++-------------- include/constants/mevent.h | 40 +++++++++++++--- include/constants/vars.h | 16 +++---- include/event_data.h | 4 +- include/global.h | 45 +++++++++--------- include/main.h | 3 +- include/mevent.h | 56 ++++++++++++---------- include/mevent2.h | 6 --- include/mevent_client.h | 62 ++++++++++++++++-------- include/mevent_news.h | 4 +- include/mevent_server.h | 102 ++++++++++++++++++++++++++++++++-------- include/mevent_server_helpers.h | 33 ++++++++----- include/mystery_gift.h | 2 +- include/wonder_transfer.h | 2 +- 14 files changed, 283 insertions(+), 160 deletions(-) delete mode 100644 include/mevent2.h (limited to 'include') diff --git a/include/constants/flags.h b/include/constants/flags.h index 880d227aa..793fe1135 100644 --- a/include/constants/flags.h +++ b/include/constants/flags.h @@ -338,24 +338,24 @@ #define FLAG_RECEIVED_AURORA_TICKET 0x13A #define FLAG_RECEIVED_MYSTIC_TICKET 0x13B #define FLAG_RECEIVED_OLD_SEA_MAP 0x13C -#define FLAG_MYSTERY_GIFT_UNUSED_1 0x13D // These mystery gift flags are referenced but never set -#define FLAG_MYSTERY_GIFT_UNUSED_2 0x13E -#define FLAG_MYSTERY_GIFT_UNUSED_3 0x13F -#define FLAG_MYSTERY_GIFT_UNUSED_4 0x140 -#define FLAG_MYSTERY_GIFT_UNUSED_5 0x141 -#define FLAG_MYSTERY_GIFT_UNUSED_6 0x142 -#define FLAG_MYSTERY_GIFT_UNUSED_7 0x143 -#define FLAG_MYSTERY_GIFT_UNUSED_8 0x144 -#define FLAG_MYSTERY_GIFT_UNUSED_9 0x145 -#define FLAG_MYSTERY_GIFT_UNUSED_10 0x146 -#define FLAG_MYSTERY_GIFT_UNUSED_11 0x147 -#define FLAG_MYSTERY_GIFT_UNUSED_12 0x148 -#define FLAG_MYSTERY_GIFT_UNUSED_13 0x149 -#define FLAG_MYSTERY_GIFT_UNUSED_14 0x14A -#define FLAG_MYSTERY_GIFT_UNUSED_15 0x14B -#define FLAG_MYSTERY_GIFT_UNUSED_16 0x14C -#define FLAG_MYSTERY_GIFT_UNUSED_17 0x14D -#define NUM_MYSTERY_GIFT_FLAGS (1 + FLAG_MYSTERY_GIFT_UNUSED_17 - FLAG_RECEIVED_AURORA_TICKET) +#define FLAG_WONDER_CARD_UNUSED_1 0x13D // These Wonder Card flags are referenced but never set +#define FLAG_WONDER_CARD_UNUSED_2 0x13E +#define FLAG_WONDER_CARD_UNUSED_3 0x13F +#define FLAG_WONDER_CARD_UNUSED_4 0x140 +#define FLAG_WONDER_CARD_UNUSED_5 0x141 +#define FLAG_WONDER_CARD_UNUSED_6 0x142 +#define FLAG_WONDER_CARD_UNUSED_7 0x143 +#define FLAG_WONDER_CARD_UNUSED_8 0x144 +#define FLAG_WONDER_CARD_UNUSED_9 0x145 +#define FLAG_WONDER_CARD_UNUSED_10 0x146 +#define FLAG_WONDER_CARD_UNUSED_11 0x147 +#define FLAG_WONDER_CARD_UNUSED_12 0x148 +#define FLAG_WONDER_CARD_UNUSED_13 0x149 +#define FLAG_WONDER_CARD_UNUSED_14 0x14A +#define FLAG_WONDER_CARD_UNUSED_15 0x14B +#define FLAG_WONDER_CARD_UNUSED_16 0x14C +#define FLAG_WONDER_CARD_UNUSED_17 0x14D +#define NUM_WONDER_CARD_FLAGS (1 + FLAG_WONDER_CARD_UNUSED_17 - FLAG_RECEIVED_AURORA_TICKET) #define FLAG_MIRAGE_TOWER_VISIBLE 0x14E #define FLAG_CHOSE_ROOT_FOSSIL 0x14F @@ -519,22 +519,22 @@ #define FLAG_UNUSED_0x1E3 0x1E3 // Unused Flag // Mystery Gift Flags (Unknown) -#define FLAG_MYSTERY_EVENT_DONE 0x1E4 -#define FLAG_MYSTERY_EVENT_1 0x1E5 -#define FLAG_MYSTERY_EVENT_2 0x1E6 -#define FLAG_MYSTERY_EVENT_3 0x1E7 -#define FLAG_MYSTERY_EVENT_4 0x1E8 -#define FLAG_MYSTERY_EVENT_5 0x1E9 -#define FLAG_MYSTERY_EVENT_6 0x1EA -#define FLAG_MYSTERY_EVENT_7 0x1EB -#define FLAG_MYSTERY_EVENT_8 0x1EC -#define FLAG_MYSTERY_EVENT_9 0x1ED -#define FLAG_MYSTERY_EVENT_10 0x1EE -#define FLAG_MYSTERY_EVENT_11 0x1EF -#define FLAG_MYSTERY_EVENT_12 0x1F0 -#define FLAG_MYSTERY_EVENT_13 0x1F1 -#define FLAG_MYSTERY_EVENT_14 0x1F2 -#define FLAG_MYSTERY_EVENT_15 0x1F3 +#define FLAG_MYSTERY_GIFT_DONE 0x1E4 +#define FLAG_MYSTERY_GIFT_1 0x1E5 +#define FLAG_MYSTERY_GIFT_2 0x1E6 +#define FLAG_MYSTERY_GIFT_3 0x1E7 +#define FLAG_MYSTERY_GIFT_4 0x1E8 +#define FLAG_MYSTERY_GIFT_5 0x1E9 +#define FLAG_MYSTERY_GIFT_6 0x1EA +#define FLAG_MYSTERY_GIFT_7 0x1EB +#define FLAG_MYSTERY_GIFT_8 0x1EC +#define FLAG_MYSTERY_GIFT_9 0x1ED +#define FLAG_MYSTERY_GIFT_10 0x1EE +#define FLAG_MYSTERY_GIFT_11 0x1EF +#define FLAG_MYSTERY_GIFT_12 0x1F0 +#define FLAG_MYSTERY_GIFT_13 0x1F1 +#define FLAG_MYSTERY_GIFT_14 0x1F2 +#define FLAG_MYSTERY_GIFT_15 0x1F3 // Hidden Items #define FLAG_HIDDEN_ITEMS_START 0x1F4 diff --git a/include/constants/mevent.h b/include/constants/mevent.h index 3478816fd..d659ffb14 100644 --- a/include/constants/mevent.h +++ b/include/constants/mevent.h @@ -1,18 +1,46 @@ #ifndef GUARD_CONSTANTS_MEVENT_H #define GUARD_CONSTANTS_MEVENT_H -// mevent2.c -#define GET_NUM_STAMPS 0 -#define GET_MAX_STAMPS 1 +#define GET_NUM_STAMPS 0 +#define GET_MAX_STAMPS 1 #define GET_CARD_BATTLES_WON 2 +#define GET_CARD_BATTLE_LOST 3 +#define GET_CARD_NUM_TRADES 4 -#define GET_NUM_STAMPS_INTERNAL 3 -#define GET_MAX_STAMPS_INTERNAL 4 -#define GET_CARD_BATTLES_WON_INTERNAL 0 +#define CARD_STAT_BATTLES_WON 0 +#define CARD_STAT_BATTLES_LOST 1 +#define CARD_STAT_NUM_TRADES 2 +#define CARD_STAT_NUM_STAMPS 3 +#define CARD_STAT_MAX_STAMPS 4 + +#define CARD_TYPE_GIFT 0 +#define CARD_TYPE_STAMP 1 // "Stamp Card" +#define CARD_TYPE_LINK_STAT 2 // Referred to as the "Battle Card", shows battle and trade stats +#define CARD_TYPE_COUNT 3 + +#define SEND_TYPE_DISALLOWED 0 +#define SEND_TYPE_ALLOWED 1 +#define SEND_TYPE_ALLOWED_ALWAYS 2 + +// Return values for MysteryGift_CompareCardFlags, handled by gMysteryGiftServerScript_SendWonderCard +#define HAS_NO_CARD 0 +#define HAS_SAME_CARD 1 +#define HAS_DIFF_CARD 2 #define REQUIRED_CARD_BATTLES 3 +#define MAX_CARD_STAMPS 7 + +// Stamps are 32 bits. The first 16 bits are the species +// and the second 16 bits are a number (presumably an ID of some kind) +#define STAMP_SPECIES 0 +#define STAMP_ID 1 + // Number of different types/colors of Wonder Card and News backgrounds #define NUM_WONDER_BGS 8 +#define MAX_WONDER_CARD_STAT 999 + +#define WONDER_CARD_FLAG_OFFSET 1000 + #endif //GUARD_MEVENT_H diff --git a/include/constants/vars.h b/include/constants/vars.h index 2cbe3e9b8..e57b02185 100644 --- a/include/constants/vars.h +++ b/include/constants/vars.h @@ -237,14 +237,14 @@ #define VAR_REGISTER_BIRCH_STATE 0x40DA #define VAR_UNUSED_0x40DB 0x40DB // Unused Var #define VAR_UNUSED_0x40DC 0x40DC // Unused Var -#define VAR_EVENT_PICHU_SLOT 0x40DD -#define VAR_NEVER_READ_0x40DE 0x40DE // Var is written to, but never read -#define VAR_NEVER_READ_0x40DF 0x40DF // Var is written to, but never read -#define VAR_NEVER_READ_0x40E0 0x40E0 // Var is written to, but never read -#define VAR_NEVER_READ_0x40E1 0x40E1 // Var is written to, but never read -#define VAR_NEVER_READ_0x40E2 0x40E2 // Var is written to, but never read -#define VAR_NEVER_READ_0x40E3 0x40E3 // Var is written to, but never read -#define VAR_NEVER_READ_0x40E4 0x40E4 // var is written to, but never read +#define VAR_GIFT_PICHU_SLOT 0x40DD +#define VAR_GIFT_UNUSED_1 0x40DE // Var is written to, but never read +#define VAR_GIFT_UNUSED_2 0x40DF // Var is written to, but never read +#define VAR_GIFT_UNUSED_3 0x40E0 // Var is written to, but never read +#define VAR_GIFT_UNUSED_4 0x40E1 // Var is written to, but never read +#define VAR_GIFT_UNUSED_5 0x40E2 // Var is written to, but never read +#define VAR_GIFT_UNUSED_6 0x40E3 // Var is written to, but never read +#define VAR_GIFT_UNUSED_7 0x40E4 // var is written to, but never read #define VAR_UNUSED_0x40E5 0x40E5 // Unused Var #define VAR_DAILY_SLOTS 0x40E6 #define VAR_DAILY_WILDS 0x40E7 diff --git a/include/event_data.h b/include/event_data.h index 8b4510e39..b1fa69460 100644 --- a/include/event_data.h +++ b/include/event_data.h @@ -13,8 +13,8 @@ bool32 IsMysteryEventEnabled(void); void DisableMysteryGift(void); void EnableMysteryGift(void); bool32 IsMysteryGiftEnabled(void); -void ClearMysteryEventFlags(void); -void ClearMysteryEventVars(void); +void ClearMysteryGiftFlags(void); +void ClearMysteryGiftVars(void); void DisableResetRTC(void); void EnableResetRTC(void); bool32 CanResetRTC(void); diff --git a/include/global.h b/include/global.h index c737be7b8..a6071b2cd 100644 --- a/include/global.h +++ b/include/global.h @@ -837,7 +837,7 @@ struct SaveTrainerHill /*0x3D6E*/ u16 tag:2; }; -struct MysteryEventStruct +struct WonderNewsMetadata { u8 unk_0_0:2; u8 unk_0_2:3; @@ -845,24 +845,24 @@ struct MysteryEventStruct u8 unk_1; }; - struct WonderNews +struct WonderNews { u16 unk_00; - u8 unk_02; + u8 sendType; // SEND_TYPE_* u8 bgType; u8 unk_04[WONDER_NEWS_TEXT_LENGTH]; u8 unk_2C[10][WONDER_NEWS_TEXT_LENGTH]; }; - struct WonderCard +struct WonderCard { u16 flagId; - u16 unk_02; + u16 iconSpecies; u32 unk_04; - u8 unk_08_0:2; + u8 type:2; // CARD_TYPE_* u8 bgType:4; - u8 unk_08_6:2; - u8 unk_09; + u8 sendType:2; // SEND_TYPE_* + u8 maxStamps; u8 unk_0A[WONDER_CARD_TEXT_LENGTH]; u8 unk_32[WONDER_CARD_TEXT_LENGTH]; u8 unk_5A[4][WONDER_CARD_TEXT_LENGTH]; @@ -870,26 +870,26 @@ struct MysteryEventStruct u8 unk_122[WONDER_CARD_TEXT_LENGTH]; }; - struct MEventBuffer_3430 +struct WonderCardMetadata { - u16 unk_00; - u16 unk_02; - u16 unk_04; - u16 unk_06; - u16 unk_08[2][7]; + u16 battlesWon; + u16 battlesLost; + u16 numTrades; + u16 iconSpecies; + u16 stampData[2][7]; }; - struct MysteryGiftSave +struct MysteryGiftSave { u32 newsCrc; struct WonderNews news; u32 cardCrc; struct WonderCard card; - u32 unkCrc; - struct MEventBuffer_3430 unk_3430; + u32 cardMetadataCrc; + struct WonderCardMetadata cardMetadata; u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; - struct MysteryEventStruct unk_340; - u32 unk_344[2][5]; + struct WonderNewsMetadata newsMetadata; + u32 trainerIds[2][5]; // Saved ids for 10 trainers, 5 each for battles and trades }; // 0x36C 0x3598 // For external event data storage. The majority of these may have never been used. @@ -966,7 +966,7 @@ struct SaveBlock1 /*0x848*/ struct Pokeblock pokeblocks[POKEBLOCKS_COUNT]; /*0x988*/ u8 seen1[DEX_FLAGS_NO]; /*0x9BC*/ u16 berryBlenderRecords[3]; - /*0x9C2*/ u8 field_9C2[6]; + /*0x9C2*/ u8 unused_9C2[6]; /*0x9C8*/ u16 trainerRematchStepCounter; /*0x9CA*/ u8 trainerRematches[MAX_REMATCH_ENTRIES]; /*0xA30*/ struct ObjectEvent objectEvents[OBJECT_EVENTS_COUNT]; @@ -986,7 +986,6 @@ struct SaveBlock1 /*0x278E*/ u8 decorationPosters[10]; /*0x2798*/ u8 decorationDolls[40]; /*0x27C0*/ u8 decorationCushions[10]; - /*0x27CA*/ u8 padding_27CA[2]; /*0x27CC*/ TVShow tvShows[TV_SHOWS_COUNT]; /*0x2B50*/ PokeNews pokeNews[POKE_NEWS_COUNT]; /*0x2B90*/ u16 outbreakPokemonSpecies; @@ -1017,7 +1016,7 @@ struct SaveBlock1 /*0x31DC*/ struct Roamer roamer; /*0x31F8*/ struct EnigmaBerry enigmaBerry; /*0x322C*/ struct MysteryGiftSave mysteryGift; - /*0x3598*/ u8 field_3598[0x180]; + /*0x3598*/ u8 unused_3598[0x180]; /*0x3718*/ u32 trainerHillTimes[4]; /*0x3728*/ struct RamScript ramScript; /*0x3B14*/ struct RecordMixingGift recordMixingGift; @@ -1025,7 +1024,7 @@ struct SaveBlock1 /*0x3B58*/ LilycoveLady lilycoveLady; /*0x3B98*/ struct TrainerNameRecord trainerNameRecords[20]; /*0x3C88*/ u8 registeredTexts[UNION_ROOM_KB_ROW_COUNT][21]; - /*0x3D5A*/ u8 filler3D5A[0xA]; + /*0x3D5A*/ u8 unused_3D5A[10]; /*0x3D64*/ struct SaveTrainerHill trainerHill; /*0x3D70*/ struct WaldaPhrase waldaPhrase; // sizeof: 0x3D88 diff --git a/include/main.h b/include/main.h index cad5c0ef9..79d56d31f 100644 --- a/include/main.h +++ b/include/main.h @@ -40,9 +40,10 @@ struct Main /*0x439*/ u8 anyLinkBattlerHasFrontierPass:1; }; +#define GAME_CODE_LENGTH 4 extern const u8 gGameVersion; extern const u8 gGameLanguage; -extern const u8 RomHeaderGameCode[4]; +extern const u8 RomHeaderGameCode[GAME_CODE_LENGTH]; extern const u8 RomHeaderSoftwareVersion; extern u16 gKeyRepeatStartDelay; diff --git a/include/mevent.h b/include/mevent.h index 4fda47fbd..1297b4291 100755 --- a/include/mevent.h +++ b/include/mevent.h @@ -1,6 +1,9 @@ #ifndef GUARD_MEVENT_H #define GUARD_MEVENT_H +#include "main.h" +#include "constants/mevent.h" + struct MEvent_Str_1 { u16 unk_000; @@ -13,51 +16,52 @@ struct MEvent_Str_2 u8 fill_00[0x40]; }; -struct MEventStruct_Unk1442CC +struct MysteryGiftLinkGameData { u32 unk_00; u16 unk_04; u32 unk_08; u16 unk_0C; u32 unk_10; - u16 unk_14; + u16 flagId; u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; - struct MEventBuffer_3430 unk_20; - u8 unk_44; + struct WonderCardMetadata cardMetadata; + u8 maxStamps; u8 playerName[PLAYER_NAME_LENGTH]; u8 playerTrainerId[TRAINER_ID_LENGTH]; u16 easyChatProfile[EASY_CHAT_BATTLE_WORDS_COUNT]; - u8 romHeaderGameCode[4]; + u8 romHeaderGameCode[GAME_CODE_LENGTH]; u8 romHeaderSoftwareVersion; }; -void sub_801AFD8(void); +void ClearMysteryGift(void); struct WonderNews *GetSavedWonderNews(void); struct WonderCard *GetSavedWonderCard(void); -struct MEventBuffer_3430 *sav1_get_mevent_buffer_2(void); -struct MysteryEventStruct *sub_801B044(void); +struct WonderCardMetadata *GetSavedWonderCardMetadata(void); +struct WonderNewsMetadata *GetSavedWonderNewsMetadata(void); u16 *GetQuestionnaireWordsPtr(void); -void ClearSavedWonderNews(void); +void ClearSavedWonderNewsAndRelated(void); +void ClearSavedWonderCardAndRelated(void); bool32 SaveWonderNews(const struct WonderNews *news); -bool32 ValidateSavedWonderNews(void); -bool32 WonderNews_Test_Unk_02(void); -bool32 sub_801B1A4(const u8 *src); -void ClearSavedWonderCard(void); bool32 SaveWonderCard(const struct WonderCard *card); +bool32 ValidateSavedWonderNews(void); bool32 ValidateSavedWonderCard(void); -bool32 WonderCard_Test_Unk_08_6(void); +bool32 IsWonderNewsSameAsSaved(const u8 *src); +bool32 IsSendingSavedWonderNewsAllowed(void); +bool32 IsSendingSavedWonderCardAllowed(void); u16 GetWonderCardFlagID(void); -void WonderCard_ResetInternalReceivedFlag(struct WonderCard *buffer); -bool32 CheckReceivedGiftFromWonderCard(void); -bool32 sub_801B508(const u16 *data); -void sub_801B580(struct MEventStruct_Unk1442CC *data, bool32 a1); -bool32 sub_801B6A0(const struct MEventStruct_Unk1442CC *data, bool32 a1); -u32 sub_801B6EC(const u16 *a0, const struct MEventStruct_Unk1442CC *a1, const void *unused); -u32 sub_801B708(const u16 *a0, const struct MEventStruct_Unk1442CC *a1, const void *unused); -bool32 MysteryGift_DoesQuestionnaireMatch(const struct MEventStruct_Unk1442CC *data, const u16 *words); -u16 MEventStruct_Unk1442CC_GetValueNFrom_unk_20(const struct MEventStruct_Unk1442CC *a0, u32 command); -u16 mevent_081445C0(u32 command); -void ResetReceivedWonderCardFlag(void); -bool32 MEventHandleReceivedWonderCard(u16 a0); +void DisableWonderCardSending(struct WonderCard *card); +bool32 IsSavedWonderCardGiftNotReceived(void); +bool32 MysteryGift_TrySaveStamp(const u16 *stamp); +void MysteryGift_LoadLinkGameData(struct MysteryGiftLinkGameData *data, bool32 a1); +bool32 MysteryGift_ValidateLinkGameData(const struct MysteryGiftLinkGameData *data, bool32 a1); +u32 MysteryGift_CompareCardFlags(const u16 *a0, const struct MysteryGiftLinkGameData *data, const void *unused); +u32 MysteryGift_CheckStamps(const u16 *a0, const struct MysteryGiftLinkGameData *data, const void *unused); +bool32 MysteryGift_DoesQuestionnaireMatch(const struct MysteryGiftLinkGameData *data, const u16 *words); +u16 MysteryGift_GetCardStatFromLinkData(const struct MysteryGiftLinkGameData *data, u32 stat); +u16 MysteryGift_GetCardStat(u32 stat); +void MysteryGift_DisableStats(void); +bool32 MysteryGift_TryEnableStatsByFlagId(u16 flagId); +void TryIncrementMysteryGiftStat(u32 stat, u32 trainerId); #endif //GUARD_MEVENT_H diff --git a/include/mevent2.h b/include/mevent2.h deleted file mode 100644 index 316a9e6de..000000000 --- a/include/mevent2.h +++ /dev/null @@ -1,6 +0,0 @@ -#ifndef GUARD_MEVENT2_H -#define GUARD_MEVENT2_H - -void RecordIdOfWonderCardSenderByEventType(u32, u32); - -#endif //GUARD_MEVENT2_H diff --git a/include/mevent_client.h b/include/mevent_client.h index f68bb7592..cc189ccc9 100644 --- a/include/mevent_client.h +++ b/include/mevent_client.h @@ -6,11 +6,11 @@ // Return values for client functions called by MysteryGiftClient_Run enum { CLI_RET_INIT, - CLI_RET_1, - CLI_RET_2, - CLI_RET_3, + CLI_RET_ACTIVE, + CLI_RET_YES_NO, + CLI_RET_PRINT_MSG, CLI_RET_ASK_TOSS, - CLI_RET_5, + CLI_RET_COPY_MSG, CLI_RET_END, }; @@ -21,25 +21,47 @@ enum { CLI_RECV, CLI_SEND_LOADED, CLI_COPY_RECV, - CLI_5, + CLI_YES_NO, CLI_COPY_RECV_IF_N, CLI_COPY_RECV_IF, - CLI_8, - CLI_9, - CLI_10, - CLI_11, - CLI_12, + CLI_LOAD_GAME_DATA, + CLI_SAVE_NEWS, + CLI_SAVE_CARD, + CLI_PRINT_MSG, + CLI_COPY_MSG, CLI_ASK_TOSS, CLI_LOAD_TOSS_RESPONSE, - CLI_15, - CLI_16, - CLI_17, + CLI_RUN_GIFT_SCRIPT, + CLI_SAVE_STAMP, + CLI_SAVE_RAM_SCRIPT, CLI_RECV_EREADER_TRAINER, CLI_SEND_STAT, - CLI_20, - CLI_21, + CLI_SEND_READY_END, + CLI_RUN_BUFFER_SCRIPT, }; +// IDs for client messages when ending a script. +// Given as the parameter to CLI_RETURN, and resolved to text in GetClientResultMessage +enum { + CLI_MSG_NOTHING_SENT, + CLI_MSG_RECORD_UPLOADED, + CLI_MSG_CARD_RECEIVED, + CLI_MSG_NEWS_RECEIVED, + CLI_MSG_STAMP_RECEIVED, + CLI_MSG_HAD_CARD, + CLI_MSG_HAD_STAMP, + CLI_MSG_HAD_NEWS, + CLI_MSG_NO_ROOM_STAMPS, + CLI_MSG_COMM_CANCELED, + CLI_MSG_CANT_ACCEPT, + CLI_MSG_COMM_ERROR, + CLI_MSG_TRAINER_RECEIVED, + CLI_MSG_BUFFER_SUCCESS, + CLI_MSG_BUFFER_FAILURE, +}; + +#define CLIENT_MAX_MSG_SIZE 64 + struct MysteryGiftClientCmd { u32 instr; @@ -48,23 +70,23 @@ struct MysteryGiftClientCmd struct MysteryGiftClient { - u32 unk_00; + u32 unused; u32 param; u32 funcId; u32 funcState; u32 cmdidx; void * sendBuffer; void * recvBuffer; - struct MysteryGiftClientCmd * cmdBuffer; - void * buffer; + struct MysteryGiftClientCmd * script; + void * msg; struct MysteryGiftLink link; bool32 isWonderNews; }; void MysteryGiftClient_Create(bool32 isWonderNews); -u32 MysteryGiftClient_Run(u16 * param); +u32 MysteryGiftClient_Run(u16 * endVal); void MysteryGiftClient_AdvanceState(void); -void * mevent_client_get_buffer(void); +void * MysteryGiftClient_GetMsg(void); void MysteryGiftClient_SetParam(u32 value); #endif //GUARD_MEVENT_CLIENT_H diff --git a/include/mevent_news.h b/include/mevent_news.h index 5fa009499..7b4657e14 100755 --- a/include/mevent_news.h +++ b/include/mevent_news.h @@ -1,7 +1,7 @@ #ifndef GUARD_MEVENT_NEWS_H #define GUARD_MEVENT_NEWS_H -void sub_801DBC0(void); -void GenerateRandomNews(u32 a0); +void InitSavedWonderNews(void); +void GenerateRandomWonderNews(u32 a0); #endif //GUARD_MEVENT_NEWS_H diff --git a/include/mevent_server.h b/include/mevent_server.h index 3152280d3..98cb03f6a 100644 --- a/include/mevent_server.h +++ b/include/mevent_server.h @@ -3,34 +3,98 @@ #include "mevent_server_helpers.h" -struct mevent_cmd +// Return values for Server_* functions. +// Other than SVR_RET_END, effectively useless (not checked for). +enum { + SVR_RET_INIT, + SVR_RET_ACTIVE, + SVR_RET_UNUSED, + SVR_RET_END +}; + +// IDs for server script instructions +enum { + SVR_RETURN, + SVR_SEND, + SVR_RECV, + SVR_GOTO, + SVR_GOTO_IF_EQ, + SVR_COPY_GAME_DATA, + SVR_CHECK_GAME_DATA_CARD, + SVR_CHECK_EXISTING_CARD, + SVR_READ_RESPONSE, + SVR_CHECK_EXISTING_STAMPS, + SVR_GET_CARD_STAT, + SVR_CHECK_QUESTIONNAIRE, + SVR_COMPARE, + SVR_LOAD_CARD, + SVR_LOAD_NEWS, + SVR_LOAD_RAM_SCRIPT, + SVR_LOAD_STAMP, + SVR_LOAD_UNK_2, + SVR_LOAD_CLIENT_SCRIPT, + SVR_LOAD_EREADER_TRAINER, + SVR_LOAD_MSG, + SVR_COPY_STAMP, + SVR_COPY_CARD, + SVR_COPY_NEWS, + SVR_SET_RAM_SCRIPT, + SVR_SET_CLIENT_SCRIPT, + SVR_COPY_SAVED_CARD, + SVR_COPY_SAVED_NEWS, + SVR_COPY_SAVED_RAM_SCRIPT, + SVR_LOAD_UNK_1, + SVR_CHECK_GAME_DATA_NEWS, +}; + +// IDs for server messages when ending a script. +// Given as the parameter to SVR_RETURN, and resolved to text in GetServerResultMessage +enum { + SVR_MSG_NOTHING_SENT, + SVR_MSG_RECORD_UPLOADED, + SVR_MSG_CARD_SENT, + SVR_MSG_NEWS_SENT, + SVR_MSG_STAMP_SENT, + SVR_MSG_HAS_CARD, + SVR_MSG_HAS_STAMP, + SVR_MSG_HAS_NEWS, + SVR_MSG_NO_ROOM_STAMPS, + SVR_MSG_CLIENT_CANCELED, + SVR_MSG_CANT_SEND_GIFT_1, + SVR_MSG_COMM_ERROR, + SVR_MSG_GIFT_SENT_1, + SVR_MSG_GIFT_SENT_2, + SVR_MSG_CANT_SEND_GIFT_2, +}; + +struct MysteryGiftServerCmd { u32 instr; - bool32 flag; - const void * parameter; + u32 parameter; + const void * ptr; }; -struct mevent_srv_common +struct MysteryGiftServer { - u32 unk_00; + u32 unused; u32 param; - u32 mainseqno; + u32 funcId; u32 cmdidx; - const struct mevent_cmd * cmdBuffer; + const struct MysteryGiftServerCmd * script; void * recvBuffer; - struct WonderCard * wonder_card; - struct WonderNews * wonder_news; - struct MEventStruct_Unk1442CC * mevent_unk1442cc; - const void * sendBuffer1; - u32 sendBuffer1Size; - const void * sendBuffer2; - u32 sendBuffer2Size; - u32 sendWord; - struct MysteryGiftLink manager; + struct WonderCard * card; + struct WonderNews * news; + struct MysteryGiftLinkGameData * linkGameData; + const void * ramScript; + u32 ramScriptSize; + const void * clientScript; + u32 clientScriptSize; + u32 stamp; + struct MysteryGiftLink link; }; -void mevent_srv_new_wcard(); -void mevent_srv_init_wnews(); -u32 mevent_srv_common_do_exec(u16 * a0); +void MysterGiftServer_CreateForCard(); +void MysterGiftServer_CreateForNews(); +u32 MysterGiftServer_Run(u16 * endVal); #endif //GUARD_MEVENT_SERVER_H diff --git a/include/mevent_server_helpers.h b/include/mevent_server_helpers.h index d2f292a0b..77d966447 100644 --- a/include/mevent_server_helpers.h +++ b/include/mevent_server_helpers.h @@ -1,13 +1,31 @@ #ifndef GUARD_MEVENT_SERVER_HELPERS_H #define GUARD_MEVENT_SERVER_HELPERS_H -#define ME_SEND_BUF_SIZE 0x400 +#define MG_LINK_BUFFER_SIZE 0x400 + +// Send/receive ids for the Client/Server to make sure +// they're sending/receiving the same thing +enum { + MG_LINKID_CLIENT_SCRIPT = 16, + MG_LINKID_GAME_DATA, + MG_LINKID_GAME_STAT, + MG_LINKID_RESPONSE, + MG_LINKID_READY_END, + MG_LINKID_DYNAMIC_MSG, + MG_LINKID_CARD, + MG_LINKID_NEWS, + MG_LINKID_STAMP, + MG_LINKID_RAM_SCRIPT, + MG_LINKID_EREADER_TRAINER, + MG_LINKID_UNK_1, + MG_LINKID_UNK_2, +}; struct MysteryGiftLink { - s32 seqno; - u8 sendPlayerNo; - u8 recvPlayerNo; + s32 state; + u8 sendPlayerId; + u8 recvPlayerId; u16 recvIdent; u16 recvCounter; u16 recvCRC; @@ -22,13 +40,6 @@ struct MysteryGiftLink u32 (*sendFunc)(struct MysteryGiftLink *); }; -struct send_recv_header -{ - u16 ident; - u16 crc; - u16 size; -}; - void MysteryGiftLink_Init(struct MysteryGiftLink *, u32, u32); void MysteryGiftLink_InitSend(struct MysteryGiftLink * manager, u32 ident, const void * src, u32 size); bool32 MysteryGiftLink_Recv(struct MysteryGiftLink * manager); diff --git a/include/mystery_gift.h b/include/mystery_gift.h index 42c7f47ba..73d3b93ea 100644 --- a/include/mystery_gift.h +++ b/include/mystery_gift.h @@ -8,7 +8,7 @@ void CB2_MysteryGiftEReader(void); void PrintMysteryGiftOrEReaderTopMenu(bool8 isJapanese, bool32 usePickOkCancel); void MG_DrawCheckerboardPattern(u32 bg); void MainCB_FreeAllBuffersAndReturnToInitTitleScreen(void); -bool32 MG_PrintTextOnWindow1AndWaitButton(u8 *textState, const u8 *str); +bool32 PrintMysteryGiftMenuMessage(u8 *textState, const u8 *str); void AddTextPrinterToWindow1(const u8 *src); void CB2_InitEReader(void); void CB2_InitMysteryGift(void); diff --git a/include/wonder_transfer.h b/include/wonder_transfer.h index 7532d6b3c..398a2b37b 100644 --- a/include/wonder_transfer.h +++ b/include/wonder_transfer.h @@ -9,7 +9,7 @@ enum { NEWS_INPUT_NONE = 0xFF }; -bool32 WonderCard_Init(struct WonderCard * card, struct MEventBuffer_3430 * r6); +bool32 WonderCard_Init(struct WonderCard * card, struct WonderCardMetadata * r6); bool32 WonderNews_Init(const struct WonderNews * news); s32 WonderCard_Enter(void); s32 WonderNews_Enter(void); -- cgit v1.2.3 From c7d550e96c88477d0e44d957439077e8f457ff61 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 17 Oct 2021 01:15:16 -0400 Subject: Clean up wonder card/news view --- include/constants/global.h | 2 ++ include/constants/mevent.h | 2 +- include/global.h | 18 +++++++++--------- include/mevent.h | 12 ------------ 4 files changed, 12 insertions(+), 22 deletions(-) (limited to 'include') diff --git a/include/constants/global.h b/include/constants/global.h index 518fe6bad..7fca5453c 100644 --- a/include/constants/global.h +++ b/include/constants/global.h @@ -89,6 +89,8 @@ #define QUIZ_QUESTION_LEN 9 #define WONDER_CARD_TEXT_LENGTH 40 #define WONDER_NEWS_TEXT_LENGTH 40 +#define WONDER_CARD_BODY_TEXT_LINES 4 +#define WONDER_NEWS_BODY_TEXT_LINES 10 #define MALE 0 #define FEMALE 1 diff --git a/include/constants/mevent.h b/include/constants/mevent.h index d659ffb14..91eacd801 100644 --- a/include/constants/mevent.h +++ b/include/constants/mevent.h @@ -13,7 +13,7 @@ #define CARD_STAT_NUM_STAMPS 3 #define CARD_STAT_MAX_STAMPS 4 -#define CARD_TYPE_GIFT 0 +#define CARD_TYPE_GIFT 0 // Normal "Wonder Card" #define CARD_TYPE_STAMP 1 // "Stamp Card" #define CARD_TYPE_LINK_STAT 2 // Referred to as the "Battle Card", shows battle and trade stats #define CARD_TYPE_COUNT 3 diff --git a/include/global.h b/include/global.h index a6071b2cd..36fbfc38d 100644 --- a/include/global.h +++ b/include/global.h @@ -850,24 +850,24 @@ struct WonderNews u16 unk_00; u8 sendType; // SEND_TYPE_* u8 bgType; - u8 unk_04[WONDER_NEWS_TEXT_LENGTH]; - u8 unk_2C[10][WONDER_NEWS_TEXT_LENGTH]; + u8 titleText[WONDER_NEWS_TEXT_LENGTH]; + u8 bodyText[WONDER_NEWS_BODY_TEXT_LINES][WONDER_NEWS_TEXT_LENGTH]; }; struct WonderCard { - u16 flagId; + u16 flagId; // Event flag (sReceivedGiftFlags) + WONDER_CARD_FLAG_OFFSET u16 iconSpecies; - u32 unk_04; + u32 idNumber; u8 type:2; // CARD_TYPE_* u8 bgType:4; u8 sendType:2; // SEND_TYPE_* u8 maxStamps; - u8 unk_0A[WONDER_CARD_TEXT_LENGTH]; - u8 unk_32[WONDER_CARD_TEXT_LENGTH]; - u8 unk_5A[4][WONDER_CARD_TEXT_LENGTH]; - u8 unk_FA[WONDER_CARD_TEXT_LENGTH]; - u8 unk_122[WONDER_CARD_TEXT_LENGTH]; + u8 titleText[WONDER_CARD_TEXT_LENGTH]; + u8 subtitleText[WONDER_CARD_TEXT_LENGTH]; + u8 bodyText[WONDER_CARD_BODY_TEXT_LINES][WONDER_CARD_TEXT_LENGTH]; + u8 footerLine1Text[WONDER_CARD_TEXT_LENGTH]; + u8 footerLine2Text[WONDER_CARD_TEXT_LENGTH]; }; struct WonderCardMetadata diff --git a/include/mevent.h b/include/mevent.h index 1297b4291..9b7ef3ab5 100755 --- a/include/mevent.h +++ b/include/mevent.h @@ -4,18 +4,6 @@ #include "main.h" #include "constants/mevent.h" -struct MEvent_Str_1 -{ - u16 unk_000; - size_t unk_004; - const void * unk_008; -}; - -struct MEvent_Str_2 -{ - u8 fill_00[0x40]; -}; - struct MysteryGiftLinkGameData { u32 unk_00; -- cgit v1.2.3 From 5f9069628d193b61b7601dc016509b91024ffa1b Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 17 Oct 2021 01:35:26 -0400 Subject: Clean up mevent2 --- include/constants/global.h | 2 ++ include/constants/mevent.h | 5 +++-- include/global.h | 4 ++-- include/mevent.h | 14 ++++++++------ 4 files changed, 15 insertions(+), 10 deletions(-) (limited to 'include') diff --git a/include/constants/global.h b/include/constants/global.h index 7fca5453c..12d6178b2 100644 --- a/include/constants/global.h +++ b/include/constants/global.h @@ -92,6 +92,8 @@ #define WONDER_CARD_BODY_TEXT_LINES 4 #define WONDER_NEWS_BODY_TEXT_LINES 10 +#define MAX_STAMP_CARD_STAMPS 7 + #define MALE 0 #define FEMALE 1 #define GENDER_COUNT 2 diff --git a/include/constants/mevent.h b/include/constants/mevent.h index 91eacd801..636043fdb 100644 --- a/include/constants/mevent.h +++ b/include/constants/mevent.h @@ -13,11 +13,13 @@ #define CARD_STAT_NUM_STAMPS 3 #define CARD_STAT_MAX_STAMPS 4 +// Values for the type field of Wonder Card #define CARD_TYPE_GIFT 0 // Normal "Wonder Card" #define CARD_TYPE_STAMP 1 // "Stamp Card" #define CARD_TYPE_LINK_STAT 2 // Referred to as the "Battle Card", shows battle and trade stats #define CARD_TYPE_COUNT 3 +// Values for the sendType field of Wonder Card/News #define SEND_TYPE_DISALLOWED 0 #define SEND_TYPE_ALLOWED 1 #define SEND_TYPE_ALLOWED_ALWAYS 2 @@ -27,10 +29,9 @@ #define HAS_SAME_CARD 1 #define HAS_DIFF_CARD 2 +// The number of battles needed to be recorded on a Battle Card to win a prize #define REQUIRED_CARD_BATTLES 3 -#define MAX_CARD_STAMPS 7 - // Stamps are 32 bits. The first 16 bits are the species // and the second 16 bits are a number (presumably an ID of some kind) #define STAMP_SPECIES 0 diff --git a/include/global.h b/include/global.h index 36fbfc38d..8681f7289 100644 --- a/include/global.h +++ b/include/global.h @@ -847,7 +847,7 @@ struct WonderNewsMetadata struct WonderNews { - u16 unk_00; + u16 id; u8 sendType; // SEND_TYPE_* u8 bgType; u8 titleText[WONDER_NEWS_TEXT_LENGTH]; @@ -876,7 +876,7 @@ struct WonderCardMetadata u16 battlesLost; u16 numTrades; u16 iconSpecies; - u16 stampData[2][7]; + u16 stampData[2][MAX_STAMP_CARD_STAMPS]; // First element is STAMP_SPECIES, second is STAMP_ID }; struct MysteryGiftSave diff --git a/include/mevent.h b/include/mevent.h index 9b7ef3ab5..c3e14f1f3 100755 --- a/include/mevent.h +++ b/include/mevent.h @@ -6,11 +6,13 @@ struct MysteryGiftLinkGameData { - u32 unk_00; - u16 unk_04; - u32 unk_08; - u16 unk_0C; - u32 unk_10; + // It's possible these first 5 fields had some other meaningful purpose, + // but they are only ever set when creating this data and read to validate it. + u32 validationVar; + u16 validationFlag1; + u32 validationFlag2; + u16 validationGiftType1; + u32 validationGiftType2; u16 flagId; u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; struct WonderCardMetadata cardMetadata; @@ -50,6 +52,6 @@ u16 MysteryGift_GetCardStatFromLinkData(const struct MysteryGiftLinkGameData *da u16 MysteryGift_GetCardStat(u32 stat); void MysteryGift_DisableStats(void); bool32 MysteryGift_TryEnableStatsByFlagId(u16 flagId); -void TryIncrementMysteryGiftStat(u32 stat, u32 trainerId); +void MysteryGift_TryIncrementStat(u32 stat, u32 trainerId); #endif //GUARD_MEVENT_H -- cgit v1.2.3 From 3cd27acbea87007fdb041035919c5b8a1b4bafcc Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 17 Oct 2021 02:09:31 -0400 Subject: Document wonder news --- include/constants/vars.h | 2 +- include/global.h | 8 ++++---- include/mevent_news.h | 10 +++++++++- 3 files changed, 14 insertions(+), 6 deletions(-) (limited to 'include') diff --git a/include/constants/vars.h b/include/constants/vars.h index e57b02185..8128b6f32 100644 --- a/include/constants/vars.h +++ b/include/constants/vars.h @@ -60,7 +60,7 @@ #define VAR_POISON_STEP_COUNTER 0x402B #define VAR_RESET_RTC_ENABLE 0x402C #define VAR_ENIGMA_BERRY_AVAILABLE 0x402D -#define VAR_0x402E 0x402E +#define VAR_WONDER_NEWS_COUNTER 0x402E #define VAR_FRONTIER_MANIAC_FACILITY 0x402F #define VAR_FRONTIER_GAMBLER_CHALLENGE 0x4030 diff --git a/include/global.h b/include/global.h index 8681f7289..d82ea875e 100644 --- a/include/global.h +++ b/include/global.h @@ -839,10 +839,10 @@ struct SaveTrainerHill struct WonderNewsMetadata { - u8 unk_0_0:2; - u8 unk_0_2:3; - u8 unk_0_5:3; - u8 unk_1; + u8 newsType:2; + u8 sentCounter:3; + u8 getCounter:3; + u8 rand; }; struct WonderNews diff --git a/include/mevent_news.h b/include/mevent_news.h index 7b4657e14..b0a0b8f07 100755 --- a/include/mevent_news.h +++ b/include/mevent_news.h @@ -1,7 +1,15 @@ #ifndef GUARD_MEVENT_NEWS_H #define GUARD_MEVENT_NEWS_H +enum { + WONDER_NEWS_NONE, + WONDER_NEWS_RECV_FRIEND, + WONDER_NEWS_RECV_WIRELESS, + WONDER_NEWS_SENT, +}; + + void InitSavedWonderNews(void); -void GenerateRandomWonderNews(u32 a0); +void GenerateRandomWonderNews(u32 newsType); #endif //GUARD_MEVENT_NEWS_H -- cgit v1.2.3 From d0455485c3ea862d4089b2b4bb02bb00f3005599 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 17 Oct 2021 02:18:24 -0400 Subject: Clean up mystery gift headers --- include/mevent.h | 10 +++++----- include/mevent_server_helpers.h | 14 +++++++------- include/wonder_transfer.h | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) (limited to 'include') diff --git a/include/mevent.h b/include/mevent.h index c3e14f1f3..be7f5f8e6 100755 --- a/include/mevent.h +++ b/include/mevent.h @@ -36,17 +36,17 @@ bool32 SaveWonderNews(const struct WonderNews *news); bool32 SaveWonderCard(const struct WonderCard *card); bool32 ValidateSavedWonderNews(void); bool32 ValidateSavedWonderCard(void); -bool32 IsWonderNewsSameAsSaved(const u8 *src); +bool32 IsWonderNewsSameAsSaved(const u8 *news); bool32 IsSendingSavedWonderNewsAllowed(void); bool32 IsSendingSavedWonderCardAllowed(void); u16 GetWonderCardFlagID(void); void DisableWonderCardSending(struct WonderCard *card); bool32 IsSavedWonderCardGiftNotReceived(void); bool32 MysteryGift_TrySaveStamp(const u16 *stamp); -void MysteryGift_LoadLinkGameData(struct MysteryGiftLinkGameData *data, bool32 a1); -bool32 MysteryGift_ValidateLinkGameData(const struct MysteryGiftLinkGameData *data, bool32 a1); -u32 MysteryGift_CompareCardFlags(const u16 *a0, const struct MysteryGiftLinkGameData *data, const void *unused); -u32 MysteryGift_CheckStamps(const u16 *a0, const struct MysteryGiftLinkGameData *data, const void *unused); +void MysteryGift_LoadLinkGameData(struct MysteryGiftLinkGameData *data, bool32 isWonderNews); +bool32 MysteryGift_ValidateLinkGameData(const struct MysteryGiftLinkGameData *data, bool32 isWonderNews); +u32 MysteryGift_CompareCardFlags(const u16 *flagId, const struct MysteryGiftLinkGameData *data, const void *unused); +u32 MysteryGift_CheckStamps(const u16 *stamp, const struct MysteryGiftLinkGameData *data, const void *unused); bool32 MysteryGift_DoesQuestionnaireMatch(const struct MysteryGiftLinkGameData *data, const u16 *words); u16 MysteryGift_GetCardStatFromLinkData(const struct MysteryGiftLinkGameData *data, u32 stat); u16 MysteryGift_GetCardStat(u32 stat); diff --git a/include/mevent_server_helpers.h b/include/mevent_server_helpers.h index 77d966447..e8556419d 100644 --- a/include/mevent_server_helpers.h +++ b/include/mevent_server_helpers.h @@ -34,16 +34,16 @@ struct MysteryGiftLink u16 sendCounter; u16 sendCRC; u16 sendSize; - void * recvBfr; - const void * sendBfr; + void * recvBuffer; + const void * sendBuffer; u32 (*recvFunc)(struct MysteryGiftLink *); u32 (*sendFunc)(struct MysteryGiftLink *); }; -void MysteryGiftLink_Init(struct MysteryGiftLink *, u32, u32); -void MysteryGiftLink_InitSend(struct MysteryGiftLink * manager, u32 ident, const void * src, u32 size); -bool32 MysteryGiftLink_Recv(struct MysteryGiftLink * manager); -bool32 MysteryGiftLink_Send(struct MysteryGiftLink * manager); -void MysteryGiftLink_InitRecv(struct MysteryGiftLink *, u32, void *); +void MysteryGiftLink_Init(struct MysteryGiftLink * link, u32 sendPlayerId, u32 recvPlayerId); +void MysteryGiftLink_InitSend(struct MysteryGiftLink * link, u32 ident, const void * src, u32 size); +bool32 MysteryGiftLink_Recv(struct MysteryGiftLink * link); +bool32 MysteryGiftLink_Send(struct MysteryGiftLink * link); +void MysteryGiftLink_InitRecv(struct MysteryGiftLink * link, u32 ident, void * dest); #endif //GUARD_MEVENT_SERVER_HELPERS_H diff --git a/include/wonder_transfer.h b/include/wonder_transfer.h index 398a2b37b..a9e80b1c7 100644 --- a/include/wonder_transfer.h +++ b/include/wonder_transfer.h @@ -9,7 +9,7 @@ enum { NEWS_INPUT_NONE = 0xFF }; -bool32 WonderCard_Init(struct WonderCard * card, struct WonderCardMetadata * r6); +bool32 WonderCard_Init(struct WonderCard * card, struct WonderCardMetadata * metadata); bool32 WonderNews_Init(const struct WonderNews * news); s32 WonderCard_Enter(void); s32 WonderNews_Enter(void); -- cgit v1.2.3 From ece7ef3410eb9b114cf328426c4fc16c972f71c6 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 17 Oct 2021 03:00:48 -0400 Subject: Correct usage of MysteryEvent to MysteryGift --- include/constants/mevent.h | 47 ------------------ include/constants/mystery_gift.h | 47 ++++++++++++++++++ include/mevent.h | 57 ---------------------- include/mevent_client.h | 92 ----------------------------------- include/mevent_news.h | 15 ------ include/mevent_server.h | 100 --------------------------------------- include/mevent_server_helpers.h | 49 ------------------- include/mystery_event_msg.h | 22 ++++----- include/mystery_event_script.h | 4 +- include/mystery_gift.h | 63 +++++++++++++++++++----- include/mystery_gift_client.h | 92 +++++++++++++++++++++++++++++++++++ include/mystery_gift_link.h | 49 +++++++++++++++++++ include/mystery_gift_menu.h | 18 +++++++ include/mystery_gift_server.h | 100 +++++++++++++++++++++++++++++++++++++++ include/mystery_gift_view.h | 24 ++++++++++ include/wonder_news.h | 15 ++++++ include/wonder_transfer.h | 24 ---------- 17 files changed, 409 insertions(+), 409 deletions(-) delete mode 100644 include/constants/mevent.h create mode 100644 include/constants/mystery_gift.h delete mode 100755 include/mevent.h delete mode 100644 include/mevent_client.h delete mode 100755 include/mevent_news.h delete mode 100644 include/mevent_server.h delete mode 100644 include/mevent_server_helpers.h mode change 100644 => 100755 include/mystery_gift.h create mode 100644 include/mystery_gift_client.h create mode 100644 include/mystery_gift_link.h create mode 100644 include/mystery_gift_menu.h create mode 100644 include/mystery_gift_server.h create mode 100644 include/mystery_gift_view.h create mode 100755 include/wonder_news.h delete mode 100644 include/wonder_transfer.h (limited to 'include') diff --git a/include/constants/mevent.h b/include/constants/mevent.h deleted file mode 100644 index 636043fdb..000000000 --- a/include/constants/mevent.h +++ /dev/null @@ -1,47 +0,0 @@ -#ifndef GUARD_CONSTANTS_MEVENT_H -#define GUARD_CONSTANTS_MEVENT_H - -#define GET_NUM_STAMPS 0 -#define GET_MAX_STAMPS 1 -#define GET_CARD_BATTLES_WON 2 -#define GET_CARD_BATTLE_LOST 3 -#define GET_CARD_NUM_TRADES 4 - -#define CARD_STAT_BATTLES_WON 0 -#define CARD_STAT_BATTLES_LOST 1 -#define CARD_STAT_NUM_TRADES 2 -#define CARD_STAT_NUM_STAMPS 3 -#define CARD_STAT_MAX_STAMPS 4 - -// Values for the type field of Wonder Card -#define CARD_TYPE_GIFT 0 // Normal "Wonder Card" -#define CARD_TYPE_STAMP 1 // "Stamp Card" -#define CARD_TYPE_LINK_STAT 2 // Referred to as the "Battle Card", shows battle and trade stats -#define CARD_TYPE_COUNT 3 - -// Values for the sendType field of Wonder Card/News -#define SEND_TYPE_DISALLOWED 0 -#define SEND_TYPE_ALLOWED 1 -#define SEND_TYPE_ALLOWED_ALWAYS 2 - -// Return values for MysteryGift_CompareCardFlags, handled by gMysteryGiftServerScript_SendWonderCard -#define HAS_NO_CARD 0 -#define HAS_SAME_CARD 1 -#define HAS_DIFF_CARD 2 - -// The number of battles needed to be recorded on a Battle Card to win a prize -#define REQUIRED_CARD_BATTLES 3 - -// Stamps are 32 bits. The first 16 bits are the species -// and the second 16 bits are a number (presumably an ID of some kind) -#define STAMP_SPECIES 0 -#define STAMP_ID 1 - -// Number of different types/colors of Wonder Card and News backgrounds -#define NUM_WONDER_BGS 8 - -#define MAX_WONDER_CARD_STAT 999 - -#define WONDER_CARD_FLAG_OFFSET 1000 - -#endif //GUARD_MEVENT_H diff --git a/include/constants/mystery_gift.h b/include/constants/mystery_gift.h new file mode 100644 index 000000000..07690e37c --- /dev/null +++ b/include/constants/mystery_gift.h @@ -0,0 +1,47 @@ +#ifndef GUARD_CONSTANTS_MYSTERY_GIFT_H +#define GUARD_CONSTANTS_MYSTERY_GIFT_H + +#define GET_NUM_STAMPS 0 +#define GET_MAX_STAMPS 1 +#define GET_CARD_BATTLES_WON 2 +#define GET_CARD_BATTLE_LOST 3 +#define GET_CARD_NUM_TRADES 4 + +#define CARD_STAT_BATTLES_WON 0 +#define CARD_STAT_BATTLES_LOST 1 +#define CARD_STAT_NUM_TRADES 2 +#define CARD_STAT_NUM_STAMPS 3 +#define CARD_STAT_MAX_STAMPS 4 + +// Values for the type field of Wonder Card +#define CARD_TYPE_GIFT 0 // Normal "Wonder Card" +#define CARD_TYPE_STAMP 1 // "Stamp Card" +#define CARD_TYPE_LINK_STAT 2 // Referred to as the "Battle Card", shows battle and trade stats +#define CARD_TYPE_COUNT 3 + +// Values for the sendType field of Wonder Card/News +#define SEND_TYPE_DISALLOWED 0 +#define SEND_TYPE_ALLOWED 1 +#define SEND_TYPE_ALLOWED_ALWAYS 2 + +// Return values for MysteryGift_CompareCardFlags, handled by gMysteryGiftServerScript_SendWonderCard +#define HAS_NO_CARD 0 +#define HAS_SAME_CARD 1 +#define HAS_DIFF_CARD 2 + +// The number of battles needed to be recorded on a Battle Card to win a prize +#define REQUIRED_CARD_BATTLES 3 + +// Stamps are 32 bits. The first 16 bits are the species +// and the second 16 bits are a number (presumably an ID of some kind) +#define STAMP_SPECIES 0 +#define STAMP_ID 1 + +// Number of different types/colors of Wonder Card and News backgrounds +#define NUM_WONDER_BGS 8 + +#define MAX_WONDER_CARD_STAT 999 + +#define WONDER_CARD_FLAG_OFFSET 1000 + +#endif //GUARD_CONSTANTS_MYSTERY_GIFT_H diff --git a/include/mevent.h b/include/mevent.h deleted file mode 100755 index be7f5f8e6..000000000 --- a/include/mevent.h +++ /dev/null @@ -1,57 +0,0 @@ -#ifndef GUARD_MEVENT_H -#define GUARD_MEVENT_H - -#include "main.h" -#include "constants/mevent.h" - -struct MysteryGiftLinkGameData -{ - // It's possible these first 5 fields had some other meaningful purpose, - // but they are only ever set when creating this data and read to validate it. - u32 validationVar; - u16 validationFlag1; - u32 validationFlag2; - u16 validationGiftType1; - u32 validationGiftType2; - u16 flagId; - u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; - struct WonderCardMetadata cardMetadata; - u8 maxStamps; - u8 playerName[PLAYER_NAME_LENGTH]; - u8 playerTrainerId[TRAINER_ID_LENGTH]; - u16 easyChatProfile[EASY_CHAT_BATTLE_WORDS_COUNT]; - u8 romHeaderGameCode[GAME_CODE_LENGTH]; - u8 romHeaderSoftwareVersion; -}; - -void ClearMysteryGift(void); -struct WonderNews *GetSavedWonderNews(void); -struct WonderCard *GetSavedWonderCard(void); -struct WonderCardMetadata *GetSavedWonderCardMetadata(void); -struct WonderNewsMetadata *GetSavedWonderNewsMetadata(void); -u16 *GetQuestionnaireWordsPtr(void); -void ClearSavedWonderNewsAndRelated(void); -void ClearSavedWonderCardAndRelated(void); -bool32 SaveWonderNews(const struct WonderNews *news); -bool32 SaveWonderCard(const struct WonderCard *card); -bool32 ValidateSavedWonderNews(void); -bool32 ValidateSavedWonderCard(void); -bool32 IsWonderNewsSameAsSaved(const u8 *news); -bool32 IsSendingSavedWonderNewsAllowed(void); -bool32 IsSendingSavedWonderCardAllowed(void); -u16 GetWonderCardFlagID(void); -void DisableWonderCardSending(struct WonderCard *card); -bool32 IsSavedWonderCardGiftNotReceived(void); -bool32 MysteryGift_TrySaveStamp(const u16 *stamp); -void MysteryGift_LoadLinkGameData(struct MysteryGiftLinkGameData *data, bool32 isWonderNews); -bool32 MysteryGift_ValidateLinkGameData(const struct MysteryGiftLinkGameData *data, bool32 isWonderNews); -u32 MysteryGift_CompareCardFlags(const u16 *flagId, const struct MysteryGiftLinkGameData *data, const void *unused); -u32 MysteryGift_CheckStamps(const u16 *stamp, const struct MysteryGiftLinkGameData *data, const void *unused); -bool32 MysteryGift_DoesQuestionnaireMatch(const struct MysteryGiftLinkGameData *data, const u16 *words); -u16 MysteryGift_GetCardStatFromLinkData(const struct MysteryGiftLinkGameData *data, u32 stat); -u16 MysteryGift_GetCardStat(u32 stat); -void MysteryGift_DisableStats(void); -bool32 MysteryGift_TryEnableStatsByFlagId(u16 flagId); -void MysteryGift_TryIncrementStat(u32 stat, u32 trainerId); - -#endif //GUARD_MEVENT_H diff --git a/include/mevent_client.h b/include/mevent_client.h deleted file mode 100644 index cc189ccc9..000000000 --- a/include/mevent_client.h +++ /dev/null @@ -1,92 +0,0 @@ -#ifndef GUARD_MEVENT_CLIENT_H -#define GUARD_MEVENT_CLIENT_H - -#include "mevent_server_helpers.h" - -// Return values for client functions called by MysteryGiftClient_Run -enum { - CLI_RET_INIT, - CLI_RET_ACTIVE, - CLI_RET_YES_NO, - CLI_RET_PRINT_MSG, - CLI_RET_ASK_TOSS, - CLI_RET_COPY_MSG, - CLI_RET_END, -}; - -// IDs for client script instructions -enum { - CLI_NONE, - CLI_RETURN, - CLI_RECV, - CLI_SEND_LOADED, - CLI_COPY_RECV, - CLI_YES_NO, - CLI_COPY_RECV_IF_N, - CLI_COPY_RECV_IF, - CLI_LOAD_GAME_DATA, - CLI_SAVE_NEWS, - CLI_SAVE_CARD, - CLI_PRINT_MSG, - CLI_COPY_MSG, - CLI_ASK_TOSS, - CLI_LOAD_TOSS_RESPONSE, - CLI_RUN_GIFT_SCRIPT, - CLI_SAVE_STAMP, - CLI_SAVE_RAM_SCRIPT, - CLI_RECV_EREADER_TRAINER, - CLI_SEND_STAT, - CLI_SEND_READY_END, - CLI_RUN_BUFFER_SCRIPT, -}; - -// IDs for client messages when ending a script. -// Given as the parameter to CLI_RETURN, and resolved to text in GetClientResultMessage -enum { - CLI_MSG_NOTHING_SENT, - CLI_MSG_RECORD_UPLOADED, - CLI_MSG_CARD_RECEIVED, - CLI_MSG_NEWS_RECEIVED, - CLI_MSG_STAMP_RECEIVED, - CLI_MSG_HAD_CARD, - CLI_MSG_HAD_STAMP, - CLI_MSG_HAD_NEWS, - CLI_MSG_NO_ROOM_STAMPS, - CLI_MSG_COMM_CANCELED, - CLI_MSG_CANT_ACCEPT, - CLI_MSG_COMM_ERROR, - CLI_MSG_TRAINER_RECEIVED, - CLI_MSG_BUFFER_SUCCESS, - CLI_MSG_BUFFER_FAILURE, -}; - -#define CLIENT_MAX_MSG_SIZE 64 - -struct MysteryGiftClientCmd -{ - u32 instr; - u32 parameter; -}; - -struct MysteryGiftClient -{ - u32 unused; - u32 param; - u32 funcId; - u32 funcState; - u32 cmdidx; - void * sendBuffer; - void * recvBuffer; - struct MysteryGiftClientCmd * script; - void * msg; - struct MysteryGiftLink link; - bool32 isWonderNews; -}; - -void MysteryGiftClient_Create(bool32 isWonderNews); -u32 MysteryGiftClient_Run(u16 * endVal); -void MysteryGiftClient_AdvanceState(void); -void * MysteryGiftClient_GetMsg(void); -void MysteryGiftClient_SetParam(u32 value); - -#endif //GUARD_MEVENT_CLIENT_H diff --git a/include/mevent_news.h b/include/mevent_news.h deleted file mode 100755 index b0a0b8f07..000000000 --- a/include/mevent_news.h +++ /dev/null @@ -1,15 +0,0 @@ -#ifndef GUARD_MEVENT_NEWS_H -#define GUARD_MEVENT_NEWS_H - -enum { - WONDER_NEWS_NONE, - WONDER_NEWS_RECV_FRIEND, - WONDER_NEWS_RECV_WIRELESS, - WONDER_NEWS_SENT, -}; - - -void InitSavedWonderNews(void); -void GenerateRandomWonderNews(u32 newsType); - -#endif //GUARD_MEVENT_NEWS_H diff --git a/include/mevent_server.h b/include/mevent_server.h deleted file mode 100644 index 98cb03f6a..000000000 --- a/include/mevent_server.h +++ /dev/null @@ -1,100 +0,0 @@ -#ifndef GUARD_MEVENT_SERVER_H -#define GUARD_MEVENT_SERVER_H - -#include "mevent_server_helpers.h" - -// Return values for Server_* functions. -// Other than SVR_RET_END, effectively useless (not checked for). -enum { - SVR_RET_INIT, - SVR_RET_ACTIVE, - SVR_RET_UNUSED, - SVR_RET_END -}; - -// IDs for server script instructions -enum { - SVR_RETURN, - SVR_SEND, - SVR_RECV, - SVR_GOTO, - SVR_GOTO_IF_EQ, - SVR_COPY_GAME_DATA, - SVR_CHECK_GAME_DATA_CARD, - SVR_CHECK_EXISTING_CARD, - SVR_READ_RESPONSE, - SVR_CHECK_EXISTING_STAMPS, - SVR_GET_CARD_STAT, - SVR_CHECK_QUESTIONNAIRE, - SVR_COMPARE, - SVR_LOAD_CARD, - SVR_LOAD_NEWS, - SVR_LOAD_RAM_SCRIPT, - SVR_LOAD_STAMP, - SVR_LOAD_UNK_2, - SVR_LOAD_CLIENT_SCRIPT, - SVR_LOAD_EREADER_TRAINER, - SVR_LOAD_MSG, - SVR_COPY_STAMP, - SVR_COPY_CARD, - SVR_COPY_NEWS, - SVR_SET_RAM_SCRIPT, - SVR_SET_CLIENT_SCRIPT, - SVR_COPY_SAVED_CARD, - SVR_COPY_SAVED_NEWS, - SVR_COPY_SAVED_RAM_SCRIPT, - SVR_LOAD_UNK_1, - SVR_CHECK_GAME_DATA_NEWS, -}; - -// IDs for server messages when ending a script. -// Given as the parameter to SVR_RETURN, and resolved to text in GetServerResultMessage -enum { - SVR_MSG_NOTHING_SENT, - SVR_MSG_RECORD_UPLOADED, - SVR_MSG_CARD_SENT, - SVR_MSG_NEWS_SENT, - SVR_MSG_STAMP_SENT, - SVR_MSG_HAS_CARD, - SVR_MSG_HAS_STAMP, - SVR_MSG_HAS_NEWS, - SVR_MSG_NO_ROOM_STAMPS, - SVR_MSG_CLIENT_CANCELED, - SVR_MSG_CANT_SEND_GIFT_1, - SVR_MSG_COMM_ERROR, - SVR_MSG_GIFT_SENT_1, - SVR_MSG_GIFT_SENT_2, - SVR_MSG_CANT_SEND_GIFT_2, -}; - -struct MysteryGiftServerCmd -{ - u32 instr; - u32 parameter; - const void * ptr; -}; - -struct MysteryGiftServer -{ - u32 unused; - u32 param; - u32 funcId; - u32 cmdidx; - const struct MysteryGiftServerCmd * script; - void * recvBuffer; - struct WonderCard * card; - struct WonderNews * news; - struct MysteryGiftLinkGameData * linkGameData; - const void * ramScript; - u32 ramScriptSize; - const void * clientScript; - u32 clientScriptSize; - u32 stamp; - struct MysteryGiftLink link; -}; - -void MysterGiftServer_CreateForCard(); -void MysterGiftServer_CreateForNews(); -u32 MysterGiftServer_Run(u16 * endVal); - -#endif //GUARD_MEVENT_SERVER_H diff --git a/include/mevent_server_helpers.h b/include/mevent_server_helpers.h deleted file mode 100644 index e8556419d..000000000 --- a/include/mevent_server_helpers.h +++ /dev/null @@ -1,49 +0,0 @@ -#ifndef GUARD_MEVENT_SERVER_HELPERS_H -#define GUARD_MEVENT_SERVER_HELPERS_H - -#define MG_LINK_BUFFER_SIZE 0x400 - -// Send/receive ids for the Client/Server to make sure -// they're sending/receiving the same thing -enum { - MG_LINKID_CLIENT_SCRIPT = 16, - MG_LINKID_GAME_DATA, - MG_LINKID_GAME_STAT, - MG_LINKID_RESPONSE, - MG_LINKID_READY_END, - MG_LINKID_DYNAMIC_MSG, - MG_LINKID_CARD, - MG_LINKID_NEWS, - MG_LINKID_STAMP, - MG_LINKID_RAM_SCRIPT, - MG_LINKID_EREADER_TRAINER, - MG_LINKID_UNK_1, - MG_LINKID_UNK_2, -}; - -struct MysteryGiftLink -{ - s32 state; - u8 sendPlayerId; - u8 recvPlayerId; - u16 recvIdent; - u16 recvCounter; - u16 recvCRC; - u16 recvSize; - u16 sendIdent; - u16 sendCounter; - u16 sendCRC; - u16 sendSize; - void * recvBuffer; - const void * sendBuffer; - u32 (*recvFunc)(struct MysteryGiftLink *); - u32 (*sendFunc)(struct MysteryGiftLink *); -}; - -void MysteryGiftLink_Init(struct MysteryGiftLink * link, u32 sendPlayerId, u32 recvPlayerId); -void MysteryGiftLink_InitSend(struct MysteryGiftLink * link, u32 ident, const void * src, u32 size); -bool32 MysteryGiftLink_Recv(struct MysteryGiftLink * link); -bool32 MysteryGiftLink_Send(struct MysteryGiftLink * link); -void MysteryGiftLink_InitRecv(struct MysteryGiftLink * link, u32 ident, void * dest); - -#endif //GUARD_MEVENT_SERVER_HELPERS_H diff --git a/include/mystery_event_msg.h b/include/mystery_event_msg.h index 465b60ccb..184496023 100644 --- a/include/mystery_event_msg.h +++ b/include/mystery_event_msg.h @@ -1,16 +1,16 @@ #ifndef GUARD_MYSTERY_EVENT_MSG_H #define GUARD_MYSTERY_EVENT_MSG_H -extern const u8 gText_MysteryGiftBerry[]; -extern const u8 gText_MysteryGiftBerryTransform[]; -extern const u8 gText_MysteryGiftBerryObtained[]; -extern const u8 gText_MysteryGiftSpecialRibbon[]; -extern const u8 gText_MysteryGiftNationalDex[]; -extern const u8 gText_MysteryGiftRareWord[]; -extern const u8 gText_MysteryGiftSentOver[]; -extern const u8 gText_MysteryGiftFullParty[]; -extern const u8 gText_MysteryGiftNewTrainer[]; -extern const u8 gText_MysteryGiftNewAdversaryInBattleTower[]; -extern const u8 gText_MysteryGiftCantBeUsed[]; +extern const u8 gText_MysteryEventBerry[]; +extern const u8 gText_MysteryEventBerryTransform[]; +extern const u8 gText_MysteryEventBerryObtained[]; +extern const u8 gText_MysteryEventSpecialRibbon[]; +extern const u8 gText_MysteryEventNationalDex[]; +extern const u8 gText_MysteryEventRareWord[]; +extern const u8 gText_MysteryEventSentOver[]; +extern const u8 gText_MysteryEventFullParty[]; +extern const u8 gText_MysteryEventNewTrainer[]; +extern const u8 gText_MysteryEventNewAdversaryInBattleTower[]; +extern const u8 gText_MysteryEventCantBeUsed[]; #endif // GUARD_MYSTERY_EVENT_MSG_H diff --git a/include/mystery_event_script.h b/include/mystery_event_script.h index 807c78b13..32b9f009f 100644 --- a/include/mystery_event_script.h +++ b/include/mystery_event_script.h @@ -1,8 +1,8 @@ #ifndef GUARD_MYSTERY_EVENT_SCRIPT_H #define GUARD_MYSTERY_EVENT_SCRIPT_H -void InitMysteryGiftScriptContext(u8 *script); -bool32 RunMysteryGiftScriptContextCommand(u32 *script); +void InitMysteryEventScriptContext(u8 *script); +bool32 RunMysteryEventScriptContextCommand(u32 *script); u32 RunMysteryEventScript(u8 *script); void SetMysteryEventScriptStatus(u32 val); u16 GetRecordMixingGift(void); diff --git a/include/mystery_gift.h b/include/mystery_gift.h old mode 100644 new mode 100755 index 73d3b93ea..3b27b3f2d --- a/include/mystery_gift.h +++ b/include/mystery_gift.h @@ -1,18 +1,57 @@ #ifndef GUARD_MYSTERY_GIFT_H #define GUARD_MYSTERY_GIFT_H -extern bool8 gGiftIsFromEReader; +#include "main.h" +#include "constants/mystery_gift.h" -u16 GetMysteryGiftBaseBlock(void); -void CB2_MysteryGiftEReader(void); -void PrintMysteryGiftOrEReaderTopMenu(bool8 isJapanese, bool32 usePickOkCancel); -void MG_DrawCheckerboardPattern(u32 bg); -void MainCB_FreeAllBuffersAndReturnToInitTitleScreen(void); -bool32 PrintMysteryGiftMenuMessage(u8 *textState, const u8 *str); -void AddTextPrinterToWindow1(const u8 *src); -void CB2_InitEReader(void); -void CB2_InitMysteryGift(void); -void MG_DrawTextBorder(u8 windowId); -s8 DoMysteryGiftYesNo(u8 *textState, u16 *windowId, bool8 yesNoBoxPlacement, const u8 *str); +struct MysteryGiftLinkGameData +{ + // It's possible these first 5 fields had some other meaningful purpose, + // but they are only ever set when creating this data and read to validate it. + u32 validationVar; + u16 validationFlag1; + u32 validationFlag2; + u16 validationGiftType1; + u32 validationGiftType2; + u16 flagId; + u16 questionnaireWords[NUM_QUESTIONNAIRE_WORDS]; + struct WonderCardMetadata cardMetadata; + u8 maxStamps; + u8 playerName[PLAYER_NAME_LENGTH]; + u8 playerTrainerId[TRAINER_ID_LENGTH]; + u16 easyChatProfile[EASY_CHAT_BATTLE_WORDS_COUNT]; + u8 romHeaderGameCode[GAME_CODE_LENGTH]; + u8 romHeaderSoftwareVersion; +}; + +void ClearMysteryGift(void); +struct WonderNews *GetSavedWonderNews(void); +struct WonderCard *GetSavedWonderCard(void); +struct WonderCardMetadata *GetSavedWonderCardMetadata(void); +struct WonderNewsMetadata *GetSavedWonderNewsMetadata(void); +u16 *GetQuestionnaireWordsPtr(void); +void ClearSavedWonderNewsAndRelated(void); +void ClearSavedWonderCardAndRelated(void); +bool32 SaveWonderNews(const struct WonderNews *news); +bool32 SaveWonderCard(const struct WonderCard *card); +bool32 ValidateSavedWonderNews(void); +bool32 ValidateSavedWonderCard(void); +bool32 IsWonderNewsSameAsSaved(const u8 *news); +bool32 IsSendingSavedWonderNewsAllowed(void); +bool32 IsSendingSavedWonderCardAllowed(void); +u16 GetWonderCardFlagID(void); +void DisableWonderCardSending(struct WonderCard *card); +bool32 IsSavedWonderCardGiftNotReceived(void); +bool32 MysteryGift_TrySaveStamp(const u16 *stamp); +void MysteryGift_LoadLinkGameData(struct MysteryGiftLinkGameData *data, bool32 isWonderNews); +bool32 MysteryGift_ValidateLinkGameData(const struct MysteryGiftLinkGameData *data, bool32 isWonderNews); +u32 MysteryGift_CompareCardFlags(const u16 *flagId, const struct MysteryGiftLinkGameData *data, const void *unused); +u32 MysteryGift_CheckStamps(const u16 *stamp, const struct MysteryGiftLinkGameData *data, const void *unused); +bool32 MysteryGift_DoesQuestionnaireMatch(const struct MysteryGiftLinkGameData *data, const u16 *words); +u16 MysteryGift_GetCardStatFromLinkData(const struct MysteryGiftLinkGameData *data, u32 stat); +u16 MysteryGift_GetCardStat(u32 stat); +void MysteryGift_DisableStats(void); +bool32 MysteryGift_TryEnableStatsByFlagId(u16 flagId); +void MysteryGift_TryIncrementStat(u32 stat, u32 trainerId); #endif //GUARD_MYSTERY_GIFT_H diff --git a/include/mystery_gift_client.h b/include/mystery_gift_client.h new file mode 100644 index 000000000..8214d69ef --- /dev/null +++ b/include/mystery_gift_client.h @@ -0,0 +1,92 @@ +#ifndef GUARD_MYSTERY_GIFT_CLIENT_H +#define GUARD_MYSTERY_GIFT_CLIENT_H + +#include "mystery_gift_link.h" + +// Return values for client functions called by MysteryGiftClient_Run +enum { + CLI_RET_INIT, + CLI_RET_ACTIVE, + CLI_RET_YES_NO, + CLI_RET_PRINT_MSG, + CLI_RET_ASK_TOSS, + CLI_RET_COPY_MSG, + CLI_RET_END, +}; + +// IDs for client script instructions +enum { + CLI_NONE, + CLI_RETURN, + CLI_RECV, + CLI_SEND_LOADED, + CLI_COPY_RECV, + CLI_YES_NO, + CLI_COPY_RECV_IF_N, + CLI_COPY_RECV_IF, + CLI_LOAD_GAME_DATA, + CLI_SAVE_NEWS, + CLI_SAVE_CARD, + CLI_PRINT_MSG, + CLI_COPY_MSG, + CLI_ASK_TOSS, + CLI_LOAD_TOSS_RESPONSE, + CLI_RUN_MEVENT_SCRIPT, + CLI_SAVE_STAMP, + CLI_SAVE_RAM_SCRIPT, + CLI_RECV_EREADER_TRAINER, + CLI_SEND_STAT, + CLI_SEND_READY_END, + CLI_RUN_BUFFER_SCRIPT, +}; + +// IDs for client messages when ending a script. +// Given as the parameter to CLI_RETURN, and resolved to text in GetClientResultMessage +enum { + CLI_MSG_NOTHING_SENT, + CLI_MSG_RECORD_UPLOADED, + CLI_MSG_CARD_RECEIVED, + CLI_MSG_NEWS_RECEIVED, + CLI_MSG_STAMP_RECEIVED, + CLI_MSG_HAD_CARD, + CLI_MSG_HAD_STAMP, + CLI_MSG_HAD_NEWS, + CLI_MSG_NO_ROOM_STAMPS, + CLI_MSG_COMM_CANCELED, + CLI_MSG_CANT_ACCEPT, + CLI_MSG_COMM_ERROR, + CLI_MSG_TRAINER_RECEIVED, + CLI_MSG_BUFFER_SUCCESS, + CLI_MSG_BUFFER_FAILURE, +}; + +#define CLIENT_MAX_MSG_SIZE 64 + +struct MysteryGiftClientCmd +{ + u32 instr; + u32 parameter; +}; + +struct MysteryGiftClient +{ + u32 unused; + u32 param; + u32 funcId; + u32 funcState; + u32 cmdidx; + void * sendBuffer; + void * recvBuffer; + struct MysteryGiftClientCmd * script; + void * msg; + struct MysteryGiftLink link; + bool32 isWonderNews; +}; + +void MysteryGiftClient_Create(bool32 isWonderNews); +u32 MysteryGiftClient_Run(u16 * endVal); +void MysteryGiftClient_AdvanceState(void); +void * MysteryGiftClient_GetMsg(void); +void MysteryGiftClient_SetParam(u32 value); + +#endif //GUARD_MYSTERY_GIFT_CLIENT_H diff --git a/include/mystery_gift_link.h b/include/mystery_gift_link.h new file mode 100644 index 000000000..32100db5f --- /dev/null +++ b/include/mystery_gift_link.h @@ -0,0 +1,49 @@ +#ifndef GUARD_MYSTERY_GIFT_LINK_H +#define GUARD_MYSTERY_GIFT_LINK_H + +#define MG_LINK_BUFFER_SIZE 0x400 + +// Send/receive ids for the Client/Server to make sure +// they're sending/receiving the same thing +enum { + MG_LINKID_CLIENT_SCRIPT = 16, + MG_LINKID_GAME_DATA, + MG_LINKID_GAME_STAT, + MG_LINKID_RESPONSE, + MG_LINKID_READY_END, + MG_LINKID_DYNAMIC_MSG, + MG_LINKID_CARD, + MG_LINKID_NEWS, + MG_LINKID_STAMP, + MG_LINKID_RAM_SCRIPT, + MG_LINKID_EREADER_TRAINER, + MG_LINKID_UNK_1, + MG_LINKID_UNK_2, +}; + +struct MysteryGiftLink +{ + s32 state; + u8 sendPlayerId; + u8 recvPlayerId; + u16 recvIdent; + u16 recvCounter; + u16 recvCRC; + u16 recvSize; + u16 sendIdent; + u16 sendCounter; + u16 sendCRC; + u16 sendSize; + void * recvBuffer; + const void * sendBuffer; + u32 (*recvFunc)(struct MysteryGiftLink *); + u32 (*sendFunc)(struct MysteryGiftLink *); +}; + +void MysteryGiftLink_Init(struct MysteryGiftLink * link, u32 sendPlayerId, u32 recvPlayerId); +void MysteryGiftLink_InitSend(struct MysteryGiftLink * link, u32 ident, const void * src, u32 size); +bool32 MysteryGiftLink_Recv(struct MysteryGiftLink * link); +bool32 MysteryGiftLink_Send(struct MysteryGiftLink * link); +void MysteryGiftLink_InitRecv(struct MysteryGiftLink * link, u32 ident, void * dest); + +#endif //GUARD_MYSTERY_GIFT_LINK_H diff --git a/include/mystery_gift_menu.h b/include/mystery_gift_menu.h new file mode 100644 index 000000000..dc30d3051 --- /dev/null +++ b/include/mystery_gift_menu.h @@ -0,0 +1,18 @@ +#ifndef GUARD_MYSTERY_GIFT_MENU_H +#define GUARD_MYSTERY_GIFT_MENU_H + +extern bool8 gGiftIsFromEReader; + +u16 GetMysteryGiftBaseBlock(void); +void CB2_MysteryGiftEReader(void); +void PrintMysteryGiftOrEReaderTopMenu(bool8 isJapanese, bool32 usePickOkCancel); +void MG_DrawCheckerboardPattern(u32 bg); +void MainCB_FreeAllBuffersAndReturnToInitTitleScreen(void); +bool32 PrintMysteryGiftMenuMessage(u8 *textState, const u8 *str); +void AddTextPrinterToWindow1(const u8 *src); +void CB2_InitEReader(void); +void CB2_InitMysteryGift(void); +void MG_DrawTextBorder(u8 windowId); +s8 DoMysteryGiftYesNo(u8 *textState, u16 *windowId, bool8 yesNoBoxPlacement, const u8 *str); + +#endif //GUARD_MYSTERY_GIFT_MENU_H diff --git a/include/mystery_gift_server.h b/include/mystery_gift_server.h new file mode 100644 index 000000000..8e3842f73 --- /dev/null +++ b/include/mystery_gift_server.h @@ -0,0 +1,100 @@ +#ifndef GUARD_MYSTERY_GIFT_SERVER_H +#define GUARD_MYSTERY_GIFT_SERVER_H + +#include "mystery_gift_link.h" + +// Return values for Server_* functions. +// Other than SVR_RET_END, effectively useless (not checked for). +enum { + SVR_RET_INIT, + SVR_RET_ACTIVE, + SVR_RET_UNUSED, + SVR_RET_END +}; + +// IDs for server script instructions +enum { + SVR_RETURN, + SVR_SEND, + SVR_RECV, + SVR_GOTO, + SVR_GOTO_IF_EQ, + SVR_COPY_GAME_DATA, + SVR_CHECK_GAME_DATA_CARD, + SVR_CHECK_EXISTING_CARD, + SVR_READ_RESPONSE, + SVR_CHECK_EXISTING_STAMPS, + SVR_GET_CARD_STAT, + SVR_CHECK_QUESTIONNAIRE, + SVR_COMPARE, + SVR_LOAD_CARD, + SVR_LOAD_NEWS, + SVR_LOAD_RAM_SCRIPT, + SVR_LOAD_STAMP, + SVR_LOAD_UNK_2, + SVR_LOAD_CLIENT_SCRIPT, + SVR_LOAD_EREADER_TRAINER, + SVR_LOAD_MSG, + SVR_COPY_STAMP, + SVR_COPY_CARD, + SVR_COPY_NEWS, + SVR_SET_RAM_SCRIPT, + SVR_SET_CLIENT_SCRIPT, + SVR_COPY_SAVED_CARD, + SVR_COPY_SAVED_NEWS, + SVR_COPY_SAVED_RAM_SCRIPT, + SVR_LOAD_UNK_1, + SVR_CHECK_GAME_DATA_NEWS, +}; + +// IDs for server messages when ending a script. +// Given as the parameter to SVR_RETURN, and resolved to text in GetServerResultMessage +enum { + SVR_MSG_NOTHING_SENT, + SVR_MSG_RECORD_UPLOADED, + SVR_MSG_CARD_SENT, + SVR_MSG_NEWS_SENT, + SVR_MSG_STAMP_SENT, + SVR_MSG_HAS_CARD, + SVR_MSG_HAS_STAMP, + SVR_MSG_HAS_NEWS, + SVR_MSG_NO_ROOM_STAMPS, + SVR_MSG_CLIENT_CANCELED, + SVR_MSG_CANT_SEND_GIFT_1, + SVR_MSG_COMM_ERROR, + SVR_MSG_GIFT_SENT_1, + SVR_MSG_GIFT_SENT_2, + SVR_MSG_CANT_SEND_GIFT_2, +}; + +struct MysteryGiftServerCmd +{ + u32 instr; + u32 parameter; + const void * ptr; +}; + +struct MysteryGiftServer +{ + u32 unused; + u32 param; + u32 funcId; + u32 cmdidx; + const struct MysteryGiftServerCmd * script; + void * recvBuffer; + struct WonderCard * card; + struct WonderNews * news; + struct MysteryGiftLinkGameData * linkGameData; + const void * ramScript; + u32 ramScriptSize; + const void * clientScript; + u32 clientScriptSize; + u32 stamp; + struct MysteryGiftLink link; +}; + +void MysterGiftServer_CreateForCard(); +void MysterGiftServer_CreateForNews(); +u32 MysterGiftServer_Run(u16 * endVal); + +#endif //GUARD_MYSTERY_GIFT_SERVER_H diff --git a/include/mystery_gift_view.h b/include/mystery_gift_view.h new file mode 100644 index 000000000..038093c7a --- /dev/null +++ b/include/mystery_gift_view.h @@ -0,0 +1,24 @@ +#ifndef GUARD_MYSTERY_GIFT_VIEW_H +#define GUARD_MYSTERY_GIFT_VIEW_H + +enum { + NEWS_INPUT_A, + NEWS_INPUT_B, + NEWS_INPUT_SCROLL_UP, + NEWS_INPUT_SCROLL_DOWN, + NEWS_INPUT_NONE = 0xFF +}; + +bool32 WonderCard_Init(struct WonderCard * card, struct WonderCardMetadata * metadata); +bool32 WonderNews_Init(const struct WonderNews * news); +s32 WonderCard_Enter(void); +s32 WonderNews_Enter(void); +s32 WonderCard_Exit(bool32 flag); +s32 WonderNews_Exit(bool32 flag); +void WonderCard_Destroy(void); +void WonderNews_Destroy(void); +u32 WonderNews_GetInput(u16 input); +void WonderNews_AddScrollIndicatorArrowPair(void); +void WonderNews_RemoveScrollIndicatorArrowPair(void); + +#endif //GUARD_MYSTERY_GIFT_VIEW_H diff --git a/include/wonder_news.h b/include/wonder_news.h new file mode 100755 index 000000000..68fd59e4c --- /dev/null +++ b/include/wonder_news.h @@ -0,0 +1,15 @@ +#ifndef GUARD_WONDER_NEWS_H +#define GUARD_WONDER_NEWS_H + +enum { + WONDER_NEWS_NONE, + WONDER_NEWS_RECV_FRIEND, + WONDER_NEWS_RECV_WIRELESS, + WONDER_NEWS_SENT, +}; + + +void InitSavedWonderNews(void); +void GenerateRandomWonderNews(u32 newsType); + +#endif //GUARD_WONDER_NEWS_H diff --git a/include/wonder_transfer.h b/include/wonder_transfer.h deleted file mode 100644 index a9e80b1c7..000000000 --- a/include/wonder_transfer.h +++ /dev/null @@ -1,24 +0,0 @@ -#ifndef GUARD_WONDER_TRANSFER_H -#define GUARD_WONDER_TRANSFER_H - -enum { - NEWS_INPUT_A, - NEWS_INPUT_B, - NEWS_INPUT_SCROLL_UP, - NEWS_INPUT_SCROLL_DOWN, - NEWS_INPUT_NONE = 0xFF -}; - -bool32 WonderCard_Init(struct WonderCard * card, struct WonderCardMetadata * metadata); -bool32 WonderNews_Init(const struct WonderNews * news); -s32 WonderCard_Enter(void); -s32 WonderNews_Enter(void); -s32 WonderCard_Exit(bool32 flag); -s32 WonderNews_Exit(bool32 flag); -void WonderCard_Destroy(void); -void WonderNews_Destroy(void); -u32 WonderNews_GetInput(u16 input); -void WonderNews_AddScrollIndicatorArrowPair(void); -void WonderNews_RemoveScrollIndicatorArrowPair(void); - -#endif //GUARD_WONDER_TRANSFER_H -- cgit v1.2.3 From 303ce856ad307c9035a336ce7232a0c4decc4b98 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 21 Oct 2021 16:54:16 -0400 Subject: Fix GET_CARD_BATTLE_LOST typo --- include/constants/mystery_gift.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'include') diff --git a/include/constants/mystery_gift.h b/include/constants/mystery_gift.h index 07690e37c..8ff71c3aa 100644 --- a/include/constants/mystery_gift.h +++ b/include/constants/mystery_gift.h @@ -4,7 +4,7 @@ #define GET_NUM_STAMPS 0 #define GET_MAX_STAMPS 1 #define GET_CARD_BATTLES_WON 2 -#define GET_CARD_BATTLE_LOST 3 +#define GET_CARD_BATTLES_LOST 3 #define GET_CARD_NUM_TRADES 4 #define CARD_STAT_BATTLES_WON 0 -- cgit v1.2.3