Sync mystery gift server, client, scripts

2022-11-19 21:49:50 -05:00
parent 12b0c70069
commit af6837c093
11 changed files with 800 additions and 648 deletions
@@ -325,6 +325,6 @@ void SetUnionRoomChatPlayerData(u32 numPlayers);
 void ClearRecvCommands(void);

 #include "mystery_gift_server.h"
-extern const struct mevent_server_cmd gServerScript_ClientCanceledCard[];
+extern const struct MysteryGiftServerCmd gServerScript_ClientCanceledCard[];

 #endif //GUARD_LINK_RFU_H
@@ -79,8 +79,8 @@ void DisableWonderCardSending(struct WonderCard * card);
 bool32 MysteryGift_TrySaveStamp(const u16 * stamp);
 void MysteryGift_LoadLinkGameData(struct MysteryGiftLinkGameData * data);
 bool32 MysteryGift_ValidateLinkGameData(const struct MysteryGiftLinkGameData * data);
-u32 MysteryGift_CompareCardFlags(const u16 * flagId, const struct MysteryGiftLinkGameData * data, void *unused);
-u32 MysteryGift_CheckStamps(const u16 * stamp, const struct MysteryGiftLinkGameData * data, void *unused);
+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);
 bool32 WonderCard_Init(struct WonderCard * card, struct WonderCardMetadata * metadata);
@@ -0,0 +1,91 @@
+#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;
+};
+
+void MysteryGiftClient_Create(void);
+u32 MysteryGiftClient_Run(u16 * endVal);
+void MysteryGiftClient_AdvanceState(void);
+void * MysteryGiftClient_GetMsg(void);
+void MysteryGiftClient_SetParam(u32 value);
+
+#endif //GUARD_MYSTERY_GIFT_CLIENT_H
@@ -0,0 +1,50 @@
+#ifndef GUARD_MYSTERY_GIFT_LINK_H
+#define GUARD_MYSTERY_GIFT_LINK_H
+
+#define MG_LINK_BUFFER_SIZE 0x400
+#define ME_SEND_BUF_SIZE MG_LINK_BUFFER_SIZE
+
+// 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
@@ -2,121 +2,103 @@
 #define GUARD_MYSTERY_GIFT_SERVER_H

 #include "global.h"
+#include "mystery_gift_link.h"

-#define ME_SEND_BUF_SIZE 0x400
-
-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 *);
+// 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
 };

-struct mevent_client_cmd
-{
-    u32 instr;
-    u32 parameter;
+// 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, // In Emerald, this was separated into SVR_CHECK_GAME_DATA_CARD and SVR_CHECK_GAME_DATA_NEWS
+    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,
 };

-// Client commands
-#define CLI_RETURN(x)  {.instr =  1, .parameter = x}
-#define CLI_RECEIVE(x) {.instr =  2, .parameter = x}
-#define CLI_WAITSND    {.instr =  3, .parameter = 0}
-#define CLI_JUMPBUF    {.instr =  4, .parameter = 0}
-#define CLI_SNDHEAD    {.instr =  8, .parameter = 0}
-#define CLI_VLDNEWS    {.instr =  9, .parameter = 0}
-#define CLI_RECVSAV    {.instr = 10, .parameter = 0}
-#define CLI_RECVBUF    {.instr = 12, .parameter = 0}
-#define CLI_REQWORD    {.instr = 13, .parameter = 0}
-#define CLI_SNDWORD    {.instr = 14, .parameter = 0}
-#define CLI_RECVMON    {.instr = 16, .parameter = 0}
-#define CLI_RECVRAM    {.instr = 17, .parameter = 0}
-#define CLI_SENDALL    {.instr = 20, .parameter = 0}
+// Create arguments for SVR_LOAD_CLIENT_SCRIPT or SVR_LOAD_MSG
+// (a script/text size and pointer to send to the client)
+#define PTR_ARG(pointer) .flag = sizeof(pointer), .parameter = pointer

-struct mevent_client
-{
-    u32 unk_00;
-    u32 param;
-    u32 mainseqno;
-    u32 flag;
-    u32 cmdidx;
-    void *sendBuffer;
-    void *recvBuffer;
-    struct mevent_client_cmd * cmdBuffer;
-    void *buffer;
-    struct MysteryGiftLink manager;
+// 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 mevent_server_cmd
+struct MysteryGiftServerCmd
 {
    u32 instr;
    bool32 flag;
-    void *parameter;
+    const void *parameter;
 };

-// Server commands
-#define SRV_RETURN(x)           {.instr =  0, .flag = x}
-#define SRV_WAITSND             {.instr =  1}
-#define SRV_RECV(x)             {.instr =  2, .flag = x}
-#define SRV_BRANCH(y)           {.instr =  3, .parameter = (void *)y}
-#define SRV_BRANCHIF(x, y)      {.instr =  4, .flag = x, .parameter = (void *)y}
-#define SRV_READ_1442CC         {.instr =  5}
-#define SRV_VALID_1442CC        {.instr =  6}
-#define SRV_CHECK_1442CC_14     {.instr =  7}
-#define SRV_READWORD            {.instr =  8}
-#define SRV_SEND_CARD           {.instr = 13}
-#define SRV_SEND_NEWS           {.instr = 14}
-#define SRV_BUFFER_SEND         {.instr = 15}
-#define SRV_SEND(x, y)          {.instr = 18, .flag = x, .parameter = (void *)y}
-#define SRV_SENDSTR(x, y)       {.instr = 20, .flag = x, .parameter = (void *)y}
-#define SRV_BUFFER_CARD         {.instr = 26}
-#define SRV_BUFFER_NEWS         {.instr = 27}
-#define SRV_RAM_SCRIPT_IF_VALID {.instr = 28}
-
-struct mevent_srv_common
+struct MysteryGiftServer
 {
-    u32 unk_00;
+    u32 unused;
    u32 param;
-    u32 mainseqno;
+    u32 funcId;
    u32 cmdidx;
-    const struct mevent_server_cmd * cmdBuffer;
+    const struct MysteryGiftServerCmd * script;
    void *recvBuffer;
    struct WonderCard * card;
    struct WonderNews * news;
-    struct MysteryGiftLinkGameData * mevent_unk1442cc;
-    void *sendBuffer1;
-    u32 sendBuffer1Size;
-    void *sendBuffer2;
-    u32 sendBuffer2Size;
-    u32 sendWord;
+    struct MysteryGiftLinkGameData * linkGameData;
+    const void *ramScript;
+    u32 ramScriptSize;
+    const void *clientScript;
+    u32 clientScriptSize;
+    u32 stamp;
    struct MysteryGiftLink manager;
 };

-u32 MysteryGiftLink_Recv(struct MysteryGiftLink * link);
-u32 MysteryGiftLink_Send(struct MysteryGiftLink * link);
-void MysteryGiftLink_Init(struct MysteryGiftLink * link, u32 sendPlayerId, u32 recvPlayerId);
-void MysteryGiftLink_InitSend(struct MysteryGiftLink * link, u32 ident, const void *src, u32 size);
-void MysteryGiftLink_InitRecv(struct MysteryGiftLink * link, u32 ident, void *dest);
-
-void mevent_client_do_init(void);
-u32 mevent_client_do_exec(u16 * a0);
-void mevent_client_inc_flag(void);
-void *mevent_client_get_buffer(void);
-void mevent_client_set_param(u32 a0);
-void mevent_srv_init_wnews(void);
-void mevent_srv_new_wcard(void);
-u32 mevent_srv_common_do_exec(u16 * a0);
+void MysterGiftServer_CreateForNews(void);
+void MysterGiftServer_CreateForCard(void);
+u32 MysterGiftServer_Run(u16 * endVal);

 #endif //GUARD_MYSTERY_GIFT_SERVER_H