Merge branch 'doc-ttower' of https://github.com/GriffinRichards/pokefirered into doc-ttower

5 files changed, 146 insertions, 11 deletions

diff --git a/include/constants/battle.h b/include/constants/battle.h
index 2da89d815..b28955210 100644
--- a/include/constants/battle.h
+++ b/include/constants/battle.h
@@ -58,14 +58,15 @@
 #define BATTLE_TYPE_EREADER_TRAINER  0x0800
 #define BATTLE_TYPE_KYOGRE_GROUDON   0x1000
 #define BATTLE_TYPE_LEGENDARY        0x2000
+#define BATTLE_TYPE_GHOST_UNVEILED   0x2000 // Re-use of BATTLE_TYPE_LEGENDARY, when combined with BATTLE_TYPE_GHOST
 #define BATTLE_TYPE_REGI             0x4000
 #define BATTLE_TYPE_GHOST            0x8000
 #define BATTLE_TYPE_POKEDUDE         0x10000
-#define BATTLE_TYPE_PALACE           0x20000
-#define BATTLE_TYPE_ARENA            0x40000
+#define BATTLE_TYPE_WILD_SCRIPTED    0x20000
+#define BATTLE_TYPE_LEGENDARY_FRLG   0x40000
 #define BATTLE_TYPE_TRAINER_TOWER    0x80000
-#define BATTLE_TYPE_PIKE             0x100000
-#define BATTLE_TYPE_PYRAMID          0x200000
+#define BATTLE_TYPE_x100000          0x100000
+#define BATTLE_TYPE_x200000          0x200000
 #define BATTLE_TYPE_INGAME_PARTNER   0x400000
 #define BATTLE_TYPE_x800000          0x800000
 #define BATTLE_TYPE_RECORDED         0x1000000
@@ -76,8 +77,9 @@
 #define BATTLE_TYPE_KYOGRE           0x20000000
 #define BATTLE_TYPE_RAYQUAZA         0x40000000
 #define BATTLE_TYPE_x80000000        0x80000000
-#define BATTLE_TYPE_FRONTIER                (BATTLE_TYPE_BATTLE_TOWER | BATTLE_TYPE_DOME | BATTLE_TYPE_PALACE | BATTLE_TYPE_ARENA | BATTLE_TYPE_FACTORY | BATTLE_TYPE_PIKE | BATTLE_TYPE_PYRAMID)
-#define BATTLE_TYPE_FRONTIER_NO_PYRAMID     (BATTLE_TYPE_BATTLE_TOWER | BATTLE_TYPE_DOME | BATTLE_TYPE_PALACE | BATTLE_TYPE_ARENA | BATTLE_TYPE_FACTORY | BATTLE_TYPE_PIKE)
+
+#define IS_BATTLE_TYPE_GHOST_WITHOUT_SCOPE(flags) ((flags) & BATTLE_TYPE_GHOST && !((flags) & BATTLE_TYPE_GHOST_UNVEILED))
+#define IS_BATTLE_TYPE_GHOST_WITH_SCOPE(flags) ((flags) & BATTLE_TYPE_GHOST && (flags) & BATTLE_TYPE_GHOST_UNVEILED)
 
 // Battle Outcome defines
 #define B_OUTCOME_WON                  0x1
diff --git a/include/constants/battle_ai.h b/include/constants/battle_ai.h
index f55661b91..d23648f39 100644
--- a/include/constants/battle_ai.h
+++ b/include/constants/battle_ai.h
@@ -23,7 +23,7 @@
 #define AI_EFFECTIVENESS_x0     0
 
 // ai weather
-#define AI_WEATHER_SUNNY     0
+#define AI_WEATHER_SUN       0
 #define AI_WEATHER_RAIN      1
 #define AI_WEATHER_SANDSTORM 2
 #define AI_WEATHER_HAIL      3
@@ -35,8 +35,8 @@
 
 // script's table id to bit
 #define AI_SCRIPT_CHECK_BAD_MOVE (1 << 0)
-#define AI_SCRIPT_TRY_TO_FAINT (1 << 1)
-#define AI_SCRIPT_CHECK_VIABILITY (1 << 2)
+#define AI_SCRIPT_CHECK_VIABILITY (1 << 1)
+#define AI_SCRIPT_TRY_TO_FAINT (1 << 2)
 #define AI_SCRIPT_SETUP_FIRST_TURN (1 << 3)
 #define AI_SCRIPT_RISKY (1 << 4)
 #define AI_SCRIPT_PREFER_STRONGEST_MOVE (1 << 5)
diff --git a/include/constants/event_object_movement.h b/include/constants/event_object_movement.h
index 6a4405b65..bf75a47cc 100644
--- a/include/constants/event_object_movement.h
+++ b/include/constants/event_object_movement.h
@@ -1,6 +1,7 @@
 #ifndef GUARD_CONSTANTS_EVENT_OBJECT_MOVEMENT_H
 #define GUARD_CONSTANTS_EVENT_OBJECT_MOVEMENT_H
 
+// FIXME: Different in FRLG
 #define MOVEMENT_TYPE_NONE                             0x0
 #define MOVEMENT_TYPE_LOOK_AROUND                      0x1
 #define MOVEMENT_TYPE_WANDER_AROUND                    0x2
@@ -239,8 +240,10 @@
 #define MOVEMENT_ACTION_STOP_LEVITATE                   0x99
 #define MOVEMENT_ACTION_DESTROY_EXTRA_TASK_IF_AT_TOP    0x9A
 #define MOVEMENT_ACTION_FIGURE_8                        0x9B
-#define MOVEMENT_ACTION_FLY_UP                          0x9C
-#define MOVEMENT_ACTION_FLY_DOWN                        0x9D
+
+// These two are verified correct in FRLG
+#define MOVEMENT_ACTION_FLY_UP                          0xA4
+#define MOVEMENT_ACTION_FLY_DOWN                        0xA5
 
 #define MOVEMENT_ACTION_STEP_END 0xFE
 
diff --git a/include/constants/metatile_labels.h b/include/constants/metatile_labels.h
index 292852b4f..ac2cb6469 100644
--- a/include/constants/metatile_labels.h
+++ b/include/constants/metatile_labels.h
@@ -37,6 +37,16 @@
 #define METATILE_PokemonMansion_Statue_RedEyes_Shade                     0x34E
 #define METATILE_PokemonMansion_Statue_RedEyes_Basement                  0x34F
 
+// Cinnabar Gym
+#define METATILE_CinnabarGym_Floor                  0x281
+#define METATILE_CinnabarGym_Floor_ShadeDiagonal    0x282
+#define METATILE_CinnabarGym_Floor_ShadeFull        0x289
+#define METATILE_CinnabarGym_Floor_WallRightCorner  0x2C6
+#define METATILE_CinnabarGym_Floor_WallLeftCorner   0x2C7
+#define METATILE_CinnabarGym_Floor_WallRightEdge    0x2CE
+#define METATILE_CinnabarGym_Floor_WallLeftEdge     0x2CF
+#define METATILE_CinnabarGym_Wall_RetractedBarrier  0x2D1
+
 // gTileset_82D504C. Below metatile probably needs generic name
 #define METATILE_MtEmber_CaveEntrance  0x346
 
diff --git a/include/constants/pokemon.h b/include/constants/pokemon.h
index dfbba41d9..a8009f1ff 100644
--- a/include/constants/pokemon.h
+++ b/include/constants/pokemon.h
@@ -1,6 +1,97 @@
 #ifndef GUARD_CONSTANTS_POKEMON_H
 #define GUARD_CONSTANTS_POKEMON_H
 
+// For (Set|Get)(Box)?MonData
+#define MON_DATA_PERSONALITY        0
+#define MON_DATA_OT_ID              1
+#define MON_DATA_NICKNAME           2
+#define MON_DATA_LANGUAGE           3
+#define MON_DATA_SANITY_IS_BAD_EGG  4
+#define MON_DATA_SANITY_HAS_SPECIES 5
+#define MON_DATA_SANITY_IS_EGG      6
+#define MON_DATA_OT_NAME            7
+#define MON_DATA_MARKINGS           8
+#define MON_DATA_CHECKSUM           9
+#define MON_DATA_ENCRYPT_SEPARATOR 10
+#define MON_DATA_SPECIES           11
+#define MON_DATA_HELD_ITEM         12
+#define MON_DATA_MOVE1             13
+#define MON_DATA_MOVE2             14
+#define MON_DATA_MOVE3             15
+#define MON_DATA_MOVE4             16
+#define MON_DATA_PP1               17
+#define MON_DATA_PP2               18
+#define MON_DATA_PP3               19
+#define MON_DATA_PP4               20
+#define MON_DATA_PP_BONUSES        21
+#define MON_DATA_COOL              22
+#define MON_DATA_BEAUTY            23
+#define MON_DATA_CUTE              24
+#define MON_DATA_EXP               25
+#define MON_DATA_HP_EV             26
+#define MON_DATA_ATK_EV            27
+#define MON_DATA_DEF_EV            28
+#define MON_DATA_SPEED_EV          29
+#define MON_DATA_SPATK_EV          30
+#define MON_DATA_SPDEF_EV          31
+#define MON_DATA_FRIENDSHIP        32
+#define MON_DATA_SMART             33
+#define MON_DATA_POKERUS           34
+#define MON_DATA_MET_LOCATION      35
+#define MON_DATA_MET_LEVEL         36
+#define MON_DATA_MET_GAME          37
+#define MON_DATA_POKEBALL          38
+#define MON_DATA_HP_IV             39
+#define MON_DATA_ATK_IV            40
+#define MON_DATA_DEF_IV            41
+#define MON_DATA_SPEED_IV          42
+#define MON_DATA_SPATK_IV          43
+#define MON_DATA_SPDEF_IV          44
+#define MON_DATA_IS_EGG            45
+#define MON_DATA_ABILITY_NUM       46
+#define MON_DATA_TOUGH             47
+#define MON_DATA_SHEEN             48
+#define MON_DATA_OT_GENDER         49
+#define MON_DATA_COOL_RIBBON       50
+#define MON_DATA_BEAUTY_RIBBON     51
+#define MON_DATA_CUTE_RIBBON       52
+#define MON_DATA_SMART_RIBBON      53
+#define MON_DATA_TOUGH_RIBBON      54
+#define MON_DATA_STATUS            55
+#define MON_DATA_LEVEL             56
+#define MON_DATA_HP                57
+#define MON_DATA_MAX_HP            58
+#define MON_DATA_ATK               59
+#define MON_DATA_DEF               60
+#define MON_DATA_SPEED             61
+#define MON_DATA_SPATK             62
+#define MON_DATA_SPDEF             63
+#define MON_DATA_MAIL              64
+#define MON_DATA_SPECIES2          65
+#define MON_DATA_IVS               66
+#define MON_DATA_CHAMPION_RIBBON   67
+#define MON_DATA_WINNING_RIBBON    68
+#define MON_DATA_VICTORY_RIBBON    69
+#define MON_DATA_ARTIST_RIBBON     70
+#define MON_DATA_EFFORT_RIBBON     71
+#define MON_DATA_GIFT_RIBBON_1     72
+#define MON_DATA_GIFT_RIBBON_2     73
+#define MON_DATA_GIFT_RIBBON_3     74
+#define MON_DATA_GIFT_RIBBON_4     75
+#define MON_DATA_GIFT_RIBBON_5     76
+#define MON_DATA_GIFT_RIBBON_6     77
+#define MON_DATA_GIFT_RIBBON_7     78
+#define MON_DATA_FATEFUL_ENCOUNTER 79
+#define MON_DATA_OBEDIENCE         80
+#define MON_DATA_KNOWN_MOVES       81
+#define MON_DATA_RIBBON_COUNT      82
+#define MON_DATA_RIBBONS           83
+#define MON_DATA_ATK2              84
+#define MON_DATA_DEF2              85
+#define MON_DATA_SPEED2            86
+#define MON_DATA_SPATK2            87
+#define MON_DATA_SPDEF2            88
+
 // Pokemon types
 #define TYPE_NORMAL   0x00
 #define TYPE_FIGHTING 0x01
@@ -93,4 +184,33 @@
 #define PLAYER_HAS_ONE_MON                      0x1
 #define PLAYER_HAS_ONE_USABLE_MON               0x2
 
+#define MAX_LEVEL 100
+
+#define OT_ID_RANDOM_NO_SHINY 2
+#define OT_ID_PRESET 1
+#define OT_ID_PLAYER_ID 0
+
+#define MON_GIVEN_TO_PARTY      0x0
+#define MON_GIVEN_TO_PC         0x1
+#define MON_CANT_GIVE           0x2
+
+#define MON_MALE       0x00
+#define MON_FEMALE     0xFE
+#define MON_GENDERLESS 0xFF
+
+#define FRIENDSHIP_EVENT_GROW_LEVEL           0x0
+#define FRIENDSHIP_EVENT_VITAMIN              0x1
+#define FRIENDSHIP_EVENT_BATTLE_ITEM          0x2
+#define FRIENDSHIP_EVENT_LEAGUE_BATTLE        0x3
+#define FRIENDSHIP_EVENT_LEARN_TMHM           0x4
+#define FRIENDSHIP_EVENT_WALKING              0x5
+#define FRIENDSHIP_EVENT_FAINT_SMALL          0x6
+#define FRIENDSHIP_EVENT_FAINT_OUTSIDE_BATTLE 0x7
+#define FRIENDSHIP_EVENT_FAINT_LARGE          0x8
+
+#define PARTY_SIZE 6
+#define MAX_TOTAL_EVS 510
+#define UNOWN_FORM_COUNT 28
+#define MAX_MON_LEVEL 100
+
 #endif // GUARD_CONSTANTS_POKEMON_H