summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPhlosioneer <mattmdrr2@gmail.com>2019-02-27 23:54:51 -0500
committerPhlosioneer <mattmdrr2@gmail.com>2019-02-27 23:54:51 -0500
commitbf45b83c65026a84425e3bc1f99e269653ed8c8b (patch)
treeaf156de0cd3cb382ec53301de3c2812869837b8d /include
parent782979f1fc37c358a5c675a1c42afae9b0027805 (diff)
Finish documenting event vars
Diffstat (limited to 'include')
-rwxr-xr-xinclude/constants/map_types.h6
-rw-r--r--include/constants/vars.h28
-rw-r--r--include/event_data.h2
-rw-r--r--include/field_specials.h10
-rw-r--r--include/overworld.h2
5 files changed, 24 insertions, 24 deletions
diff --git a/include/constants/map_types.h b/include/constants/map_types.h
index 504575859..8d071fd41 100755
--- a/include/constants/map_types.h
+++ b/include/constants/map_types.h
@@ -1,14 +1,14 @@
#ifndef GUARD_CONSTANTS_MAP_TYPES_H
#define GUARD_CONSTANTS_MAP_TYPES_H
-#define MAP_TYPE_0 0
+#define MAP_TYPE_UNUSED_1 0
#define MAP_TYPE_TOWN 1
#define MAP_TYPE_CITY 2
#define MAP_TYPE_ROUTE 3
#define MAP_TYPE_UNDERGROUND 4
#define MAP_TYPE_UNDERWATER 5
-#define MAP_TYPE_6 6
-#define MAP_TYPE_7 7
+#define MAP_TYPE_OCEAN_ROUTE 6
+#define MAP_TYPE_UNUSED_2 7
#define MAP_TYPE_INDOOR 8
#define MAP_TYPE_SECRET_BASE 9
diff --git a/include/constants/vars.h b/include/constants/vars.h
index 59489f051..99d1813da 100644
--- a/include/constants/vars.h
+++ b/include/constants/vars.h
@@ -231,9 +231,9 @@
#define VAR_SS_TIDAL_SCOTT_STATE 0x40D4 // Always equal to FLAG_MET_SCOTT_ON_SS_TIDAL
#define VAR_ROAMER_POKEMON 0x40D5 // 0 = Latias, 1 = Latios
#define VAR_TRAINER_HILL_IS_ACTIVE 0x40D6
-#define VAR_0x40D7 0x40D7
-#define VAR_0x40D8 0x40D8
-#define VAR_0x40D9 0x40D9
+#define VAR_SKY_PILLAR_RAQUAZA_CRY_DONE 0x40D7
+#define VAR_SOOTOPOLIS_STATE 0x40D8
+#define VAR_HAS_TALKED_TO_SEAFLOOR_CAVERN_ENTRANCE_GRUNT 0x40D9
#define VAR_0x40DA 0x40DA
#define VAR_UNUSED_0x40DB 0x40DB // Unused Var
#define VAR_UNUSED_0x40DC 0x40DC // Unused Var
@@ -252,17 +252,17 @@
#define VAR_DAILY_PLANTED_BERRIES 0x40E9
#define VAR_DAILY_PICKED_BERRIES 0x40EA
#define VAR_DAILY_ROULETTE 0x40EB
-#define VAR_0x40EC 0x40EC
-#define VAR_0x40ED 0x40ED
-#define VAR_0x40EE 0x40EE
-#define VAR_0x40EF 0x40EF
-#define VAR_0x40F0 0x40F0
+#define VAR_SECRET_BASE_STEP_COUNTER 0x40EC // Used by Secret Base TV programs
+#define VAR_SECRET_BASE_LAST_ITEM_USED 0x40ED // Used by Secret Base TV programs
+#define VAR_SECRET_BASE_LOW_TV_FLAGS 0x40EE // Used by Secret Base TV programs
+#define VAR_SECRET_BASE_HIGH_TV_FLAGS 0x40EF // Used by Secret Base TV programs
+#define VAR_SECRET_BASE_IS_NOT_LOCAL 0x40F0 // Set to TRUE while in another player's secret base.
#define VAR_DAILY_BP 0x40F1
-#define VAR_0x40F2 0x40F2
-#define VAR_0x40F3 0x40F3
-#define VAR_0x40F4 0x40F4
-#define VAR_0x40F5 0x40F5
-#define VAR_0x40F6 0x40F6
+#define VAR_WALLY_CALL_STEP_COUNTER 0x40F2
+#define VAR_WINONA_CALL_STEP_COUNTER 0x40F3
+#define VAR_ROXANNE_CALL_STEP_COUNTER 0x40F4
+#define VAR_SCOTT_CALL_STEP_COUNTER 0x40F5
+#define VAR_RIVAL_RAYQUAZA_CALL_STEP_COUNTER 0x40F6
#define VAR_UNUSED_0x40F7 0x40F7 // Unused Var
#define VAR_UNUSED_0x40F8 0x40F8 // Unused Var
#define VAR_UNUSED_0x40F9 0x40F9 // Unused Var
@@ -296,7 +296,7 @@
#define VAR_CONTEST_CATEGORY 0x8011
#define VAR_MON_BOX_ID 0x8012
#define VAR_MON_BOX_POS 0x8013
-#define VAR_0x8014 0x8014
+#define VAR_UNUSED_0x8014 0x8014
#define VAR_NEVER_READ_0x8015 0x8015 // Written to, but never read
#endif // GUARD_CONSTANTS_VARS_H
diff --git a/include/event_data.h b/include/event_data.h
index 3b8e2701f..11289c1ab 100644
--- a/include/event_data.h
+++ b/include/event_data.h
@@ -47,6 +47,6 @@ extern u16 gSpecialVar_LastTalked;
extern u16 gSpecialVar_Facing;
extern u16 gSpecialVar_MonBoxId;
extern u16 gSpecialVar_MonBoxPos;
-extern u16 gSpecialVar_0x8014;
+extern u16 gSpecialVar_Unused_0x8014;
#endif // GUARD_EVENT_DATA_H
diff --git a/include/field_specials.h b/include/field_specials.h
index 1ab2b7eb4..28e47fead 100644
--- a/include/field_specials.h
+++ b/include/field_specials.h
@@ -9,11 +9,11 @@ void sub_813BF10(void);
void IncrementBirthIslandRockStepCount(void);
bool8 UnusualWeatherHasExpired(void);
bool8 ShouldDoBrailleRegicePuzzle(void);
-bool32 is_tile_that_overrides_player_control(void);
-bool32 sub_8138120(void);
-bool32 sub_8138168(void);
-bool32 sub_81381B0(void);
-bool32 sub_81381F8(void);
+bool32 ShouldDoWallyCall(void);
+bool32 ShouldDoWinonaCall(void);
+bool32 ShouldDoScottCall(void);
+bool32 ShouldDoRoxanneCall(void);
+bool32 ShouldDoRivalRayquazaCall(void);
bool32 CountSSTidalStep(u16 delta);
u8 GetSSTidalLocation(s8 *mapGroup, s8 *mapNum, s16 *x, s16 *y);
void sub_813A128(void);
diff --git a/include/overworld.h b/include/overworld.h
index 8caba0673..54715ecc0 100644
--- a/include/overworld.h
+++ b/include/overworld.h
@@ -96,7 +96,7 @@ u8 GetMapTypeByGroupAndId(s8 mapGroup, s8 mapNum);
u8 GetMapTypeByWarpData(struct WarpData *warp);
u8 GetCurrentMapType(void);
u8 GetLastUsedWarpMapType(void);
-bool8 is_map_type_1_2_3_5_or_6(u8 mapType);
+bool8 IsMapTypeOutside(u8 mapType);
bool8 Overworld_MapTypeAllowsTeleportAndFly(u8 mapType);
bool8 Overworld_MapTypeIsIndoors(u8 mapType);
u8 GetSavedWarpRegionMapSectionId(void);