dionmoustos/PokemonEmeraldSafariFrontier
1
0
Fork 0
Code Issues 21 Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1519 from GriffinRichards/doc-mgift

Browse Source 
Document Mystery Gift
This commit is contained in:
GriffinR
2021-10-24 15:50:39 -04:00
committed by GitHub
parent 3834cc2957 6067aa65b4
commit ab80264921
110 changed files with 5190 additions and 4866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
include/constants/flags.h
View File

@@ -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_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
@@ -518,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

6
include/constants/global.h
View File

@@ -87,6 +87,12 @@
#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 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

15
include/constants/mevent.h
View File

@@ -1,15 +0,0 @@
#ifndef GUARD_CONSTANTS_MEVENT_H
#define GUARD_CONSTANTS_MEVENT_H
// mevent2.c
#define GET_NUM_STAMPS 0
#define GET_MAX_STAMPS 1
#define GET_CARD_BATTLES_WON 2
#define GET_NUM_STAMPS_INTERNAL 3
#define GET_MAX_STAMPS_INTERNAL 4
#define GET_CARD_BATTLES_WON_INTERNAL 0
#define REQUIRED_CARD_BATTLES 3
#endif //GUARD_MEVENT_H

47
include/constants/mystery_gift.h Normal file
View File

@@ -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_BATTLES_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

18
include/constants/vars.h
View File

@@ -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
@@ -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