Merge pull request #456 from Rangi42/master

OAM data documentation; move more content into data/; move palettes into gfx/; more code+script constants; consistent map naming

6 files changed, 129 insertions, 88 deletions

diff --git a/data/wild/fish.asm b/data/wild/fish.asm
index de7e57a33..91a887b53 100644
--- a/data/wild/fish.asm
+++ b/data/wild/fish.asm
@@ -1,3 +1,5 @@
+time_group EQUS "0," ; use the nth TimeFishGroups entry
+
 FishGroups: ; 92488
 	dbwww 50 percent + 1, .Shore_Old,            .Shore_Good,            .Shore_Super
 	dbwww 50 percent + 1, .Ocean_Old,            .Ocean_Good,            .Ocean_Super
@@ -21,10 +23,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     KRABBY,     20
 	db  90 percent + 1, KRABBY,     20
-	db 100 percent,     0, 0
+	db 100 percent,     time_group 0
 .Shore_Super: ; 924f8
 	db  40 percent,     KRABBY,     40
-	db  70 percent,     0, 1
+	db  70 percent,     time_group 1
 	db  90 percent + 1, KRABBY,     40
 	db 100 percent,     KINGLER,    40
 
@@ -36,10 +38,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     TENTACOOL,  20
 	db  90 percent + 1, CHINCHOU,   20
-	db 100 percent,     0, 2
+	db 100 percent,     time_group 2
 .Ocean_Super: ; 92519
 	db  40 percent,     CHINCHOU,   40
-	db  70 percent,     0, 3
+	db  70 percent,     time_group 3
 	db  90 percent + 1, TENTACRUEL, 40
 	db 100 percent,     LANTURN,    40
 
@@ -51,10 +53,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     GOLDEEN,    20
 	db  90 percent + 1, GOLDEEN,    20
-	db 100 percent,     0, 4
+	db 100 percent,     time_group 4
 .Lake_Super: ; 9253a
 	db  40 percent,     GOLDEEN,    40
-	db  70 percent,     0, 5
+	db  70 percent,     time_group 5
 	db  90 percent + 1, MAGIKARP,   40
 	db 100 percent,     SEAKING,    40
 
@@ -66,10 +68,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     POLIWAG,    20
 	db  90 percent + 1, POLIWAG,    20
-	db 100 percent,     0, 6
+	db 100 percent,     time_group 6
 .Pond_Super: ; 9255b
 	db  40 percent,     POLIWAG,    40
-	db  70 percent,     0, 7
+	db  70 percent,     time_group 7
 	db  90 percent + 1, MAGIKARP,   40
 	db 100 percent,     POLIWAG,    40
 
@@ -81,10 +83,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     MAGIKARP,   20
 	db  90 percent + 1, MAGIKARP,   20
-	db 100 percent,     0, 8
+	db 100 percent,     time_group 8
 .Dratini_Super: ; 9257c
 	db  40 percent,     MAGIKARP,   40
-	db  70 percent,     0, 9
+	db  70 percent,     time_group 9
 	db  90 percent + 1, MAGIKARP,   40
 	db 100 percent,     DRAGONAIR,  40
 
@@ -96,10 +98,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     QWILFISH,   20
 	db  90 percent + 1, QWILFISH,   20
-	db 100 percent,     0, 10
+	db 100 percent,     time_group 10
 .Qwilfish_Swarm_Super: ; 9259d
 	db  40 percent,     QWILFISH,   40
-	db  70 percent,     0, 11
+	db  70 percent,     time_group 11
 	db  90 percent + 1, QWILFISH,   40
 	db 100 percent,     QWILFISH,   40
 
@@ -111,10 +113,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     REMORAID,   20
 	db  90 percent + 1, REMORAID,   20
-	db 100 percent,     0, 12
+	db 100 percent,     time_group 12
 .Remoraid_Swarm_Super: ; 925be
 	db  40 percent,     REMORAID,   40
-	db  70 percent,     0, 13
+	db  70 percent,     time_group 13
 	db  90 percent + 1, REMORAID,   40
 	db 100 percent,     REMORAID,   40
 
@@ -126,10 +128,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     MAGIKARP,   20
 	db  90 percent + 1, MAGIKARP,   20
-	db 100 percent,     0, 14
+	db 100 percent,     time_group 14
 .Gyarados_Super: ; 925df
 	db  40 percent,     MAGIKARP,   40
-	db  70 percent,     0, 15
+	db  70 percent,     time_group 15
 	db  90 percent + 1, MAGIKARP,   40
 	db 100 percent,     MAGIKARP,   40
 
@@ -141,10 +143,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   10
 	db  70 percent,     MAGIKARP,   10
 	db  90 percent + 1, MAGIKARP,   10
-	db 100 percent,     0, 16
+	db 100 percent,     time_group 16
 .Dratini_2_Super: ; 92600
 	db  40 percent,     MAGIKARP,   10
-	db  70 percent,     0, 17
+	db  70 percent,     time_group 17
 	db  90 percent + 1, MAGIKARP,   10
 	db 100 percent,     DRAGONAIR,  10
 
@@ -156,10 +158,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     KRABBY,     20
 	db  90 percent + 1, KRABBY,     20
-	db 100 percent,     0, 18
+	db 100 percent,     time_group 18
 .WhirlIslands_Super: ; 92621
 	db  40 percent,     KRABBY,     40
-	db  70 percent,     0, 19
+	db  70 percent,     time_group 19
 	db  90 percent + 1, KINGLER,    40
 	db 100 percent,     SEADRA,     40
 
@@ -173,11 +175,11 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     TENTACOOL,  20
 	db  90 percent + 1, TENTACOOL,  20
-	db 100 percent,     0, 20
+	db 100 percent,     time_group 20
 .Qwilfish_NoSwarm_Super:
 .Qwilfish_Super: ; 92642
 	db  40 percent,     TENTACOOL,  40
-	db  70 percent,     0, 21
+	db  70 percent,     time_group 21
 	db  90 percent + 1, MAGIKARP,   40
 	db 100 percent,     QWILFISH,   40
 
@@ -189,10 +191,10 @@ FishGroups: ; 92488
 	db  35 percent,     MAGIKARP,   20
 	db  70 percent,     POLIWAG,    20
 	db  90 percent + 1, POLIWAG,    20
-	db 100 percent,     0, 6
+	db 100 percent,     time_group 6
 .Remoraid_Super: ; 92663
 	db  40 percent,     POLIWAG,    40
-	db  70 percent,     0, 7
+	db  70 percent,     time_group 7
 	db  90 percent + 1, MAGIKARP,   40
 	db 100 percent,     REMORAID,   40
 ; 9266f
diff --git a/data/wild/probabilities.asm b/data/wild/probabilities.asm
index a18e9d336..1813603c2 100644
--- a/data/wild/probabilities.asm
+++ b/data/wild/probabilities.asm
@@ -1,15 +1,20 @@
+mon_prob: MACRO
+; percent, index
+	db \1, \2 * 2
+ENDM
+
 GrassMonProbTable: ; 2a1cb
-	db 30,  $0 ; 30% chance
-	db 60,  $2 ; 30% chance
-	db 80,  $4 ; 20% chance
-	db 90,  $6 ; 10% chance
-	db 95,  $8 ;  5% chance
-	db 99,  $a ;  4% chance
-	db 100, $c ;  1% chance
+	mon_prob 30,  0 ; 30% chance
+	mon_prob 60,  1 ; 30% chance
+	mon_prob 80,  2 ; 20% chance
+	mon_prob 90,  3 ; 10% chance
+	mon_prob 95,  4 ;  5% chance
+	mon_prob 99,  5 ;  4% chance
+	mon_prob 100, 6 ;  1% chance
 ; 2a1d9
 
 WaterMonProbTable: ; 2a1d9
-	db 60,  $0 ; 60% chance
-	db 90,  $2 ; 30% chance
-	db 100, $4 ; 10% chance
+	mon_prob 60,  0 ; 60% chance
+	mon_prob 90,  1 ; 30% chance
+	mon_prob 100, 2 ; 10% chance
 ; 2a1df
diff --git a/data/wild/roammon_maps.asm b/data/wild/roammon_maps.asm
index c0b552b26..07bb7a9d9 100644
--- a/data/wild/roammon_maps.asm
+++ b/data/wild/roammon_maps.asm
@@ -13,6 +13,7 @@ endr
 ENDM
 
 RoamMaps: ; 2a40f
+; there are NUM_ROAMMON_MAPS entries
 	roam_map ROUTE_29, 2, ROUTE_30, ROUTE_46
 	roam_map ROUTE_30, 2, ROUTE_29, ROUTE_31
 	roam_map ROUTE_31, 3, ROUTE_30, ROUTE_32, ROUTE_36
diff --git a/data/wild/treemon_maps.asm b/data/wild/treemon_maps.asm
index e825930cc..7860110ca 100644
--- a/data/wild/treemon_maps.asm
+++ b/data/wild/treemon_maps.asm
@@ -4,47 +4,47 @@ treemon_map: MACRO
 ENDM
 
 TreeMonMaps: ; b825e
-	treemon_map ROUTE_26, 4
-	treemon_map ROUTE_27, 4
-	treemon_map ROUTE_28, 0
-	treemon_map ROUTE_29, 3
-	treemon_map ROUTE_30, 3
-	treemon_map ROUTE_31, 3
-	treemon_map ROUTE_32, 4
-	treemon_map ROUTE_33, 2
-	treemon_map ROUTE_34, 3
-	treemon_map ROUTE_35, 3
-	treemon_map ROUTE_36, 3
-	treemon_map ROUTE_37, 3
-	treemon_map ROUTE_38, 3
-	treemon_map ROUTE_39, 3
-	treemon_map ROUTE_40, 0
-	treemon_map ROUTE_41, 0
-	treemon_map ROUTE_42, 2
-	treemon_map ROUTE_43, 5
-	treemon_map ROUTE_44, 1
-	treemon_map ROUTE_45, 1
-	treemon_map ROUTE_46, 1
-	treemon_map NEW_BARK_TOWN, 0
-	treemon_map CHERRYGROVE_CITY, 0
-	treemon_map VIOLET_CITY, 0
-	treemon_map AZALEA_TOWN, 2
-	treemon_map CIANWOOD_CITY, 0
-	treemon_map GOLDENROD_CITY, 0
-	treemon_map OLIVINE_CITY, 0
-	treemon_map ECRUTEAK_CITY, 0
-	treemon_map MAHOGANY_TOWN, 0
-	treemon_map LAKE_OF_RAGE, 5
-	treemon_map BLACKTHORN_CITY, 0
-	treemon_map SILVER_CAVE_OUTSIDE, 0
-	treemon_map ILEX_FOREST, 6
+	treemon_map ROUTE_26,                  TREEMON_SET_KANTO
+	treemon_map ROUTE_27,                  TREEMON_SET_KANTO
+	treemon_map ROUTE_28,                  TREEMON_SET_CITY
+	treemon_map ROUTE_29,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_30,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_31,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_32,                  TREEMON_SET_KANTO
+	treemon_map ROUTE_33,                  TREEMON_SET_AZALEA
+	treemon_map ROUTE_34,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_35,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_36,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_37,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_38,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_39,                  TREEMON_SET_ROUTE
+	treemon_map ROUTE_40,                  TREEMON_SET_CITY
+	treemon_map ROUTE_41,                  TREEMON_SET_CITY
+	treemon_map ROUTE_42,                  TREEMON_SET_AZALEA
+	treemon_map ROUTE_43,                  TREEMON_SET_LAKE
+	treemon_map ROUTE_44,                  TREEMON_SET_CANYON
+	treemon_map ROUTE_45,                  TREEMON_SET_CANYON
+	treemon_map ROUTE_46,                  TREEMON_SET_CANYON
+	treemon_map NEW_BARK_TOWN,             TREEMON_SET_CITY
+	treemon_map CHERRYGROVE_CITY,          TREEMON_SET_CITY
+	treemon_map VIOLET_CITY,               TREEMON_SET_CITY
+	treemon_map AZALEA_TOWN,               TREEMON_SET_AZALEA
+	treemon_map CIANWOOD_CITY,             TREEMON_SET_CITY
+	treemon_map GOLDENROD_CITY,            TREEMON_SET_CITY
+	treemon_map OLIVINE_CITY,              TREEMON_SET_CITY
+	treemon_map ECRUTEAK_CITY,             TREEMON_SET_CITY
+	treemon_map MAHOGANY_TOWN,             TREEMON_SET_CITY
+	treemon_map LAKE_OF_RAGE,              TREEMON_SET_LAKE
+	treemon_map BLACKTHORN_CITY,           TREEMON_SET_CITY
+	treemon_map SILVER_CAVE_OUTSIDE,       TREEMON_SET_CITY
+	treemon_map ILEX_FOREST,               TREEMON_SET_FOREST
 	db -1
 ; b82c5
 
 RockMonMaps: ; b82c5
-	treemon_map CIANWOOD_CITY, 7
-	treemon_map ROUTE_40, 7
-	treemon_map DARK_CAVE_VIOLET_ENTRANCE, 7
-	treemon_map SLOWPOKE_WELL_B1F, 7
+	treemon_map CIANWOOD_CITY,             TREEMON_SET_ROCK
+	treemon_map ROUTE_40,                  TREEMON_SET_ROCK
+	treemon_map DARK_CAVE_VIOLET_ENTRANCE, TREEMON_SET_ROCK
+	treemon_map SLOWPOKE_WELL_B1F,         TREEMON_SET_ROCK
 	db -1
 ; b82d2
diff --git a/data/wild/treemons.asm b/data/wild/treemons.asm
index 0cb8fa83d..21cef29ec 100644
--- a/data/wild/treemons.asm
+++ b/data/wild/treemons.asm
@@ -1,19 +1,21 @@
 TreeMons: ; b82e8
-	dw TreeMons1
-	dw TreeMons1
-	dw TreeMons2
-	dw TreeMons3
-	dw TreeMons4
-	dw TreeMons5
-	dw TreeMons6
-	dw RockMons
-	dw TreeMons1
+; entries correspond to TREEMON_SET_* constants
+	dw TreeMonSet_City
+	dw TreeMonSet_Canyon
+	dw TreeMonSet_Azalea
+	dw TreeMonSet_Route
+	dw TreeMonSet_Kanto
+	dw TreeMonSet_Lake
+	dw TreeMonSet_Forest
+	dw TreeMonSet_Rock
+	dw TreeMonSet_City
 
 ; Two tables each (common, rare).
 ; Structure:
 ;	db  %, species, level
 
-TreeMons1: ; b82fa
+TreeMonSet_City:
+TreeMonSet_Canyon: ; b82fa
 ; common
 	db 50, SPEAROW,    10
 	db 15, SPEAROW,    10
@@ -31,7 +33,7 @@ TreeMons1: ; b82fa
 	db  5, AIPOM,      10
 	db -1
 
-TreeMons2: ; b8320
+TreeMonSet_Azalea: ; b8320
 ; common
 	db 50, SPEAROW,    10
 	db 15, EKANS,      10
@@ -49,7 +51,7 @@ TreeMons2: ; b8320
 	db  5, AIPOM,      10
 	db -1
 
-TreeMons3: ; b8346
+TreeMonSet_Route: ; b8346
 ; common
 	db 50, HOOTHOOT,   10
 	db 15, SPINARAK,   10
@@ -67,7 +69,7 @@ TreeMons3: ; b8346
 	db  5, EXEGGCUTE,  10
 	db -1
 
-TreeMons4: ; b836c
+TreeMonSet_Kanto: ; b836c
 ; common
 	db 50, HOOTHOOT,   10
 	db 15, EKANS,      10
@@ -85,7 +87,7 @@ TreeMons4: ; b836c
 	db  5, EXEGGCUTE,  10
 	db -1
 
-TreeMons5: ; b8392
+TreeMonSet_Lake: ; b8392
 ; common
 	db 50, HOOTHOOT,   10
 	db 15, VENONAT,    10
@@ -103,7 +105,7 @@ TreeMons5: ; b8392
 	db  5, EXEGGCUTE,  10
 	db -1
 
-TreeMons6: ; b83b8
+TreeMonSet_Forest: ; b83b8
 ; common
 	db 50, HOOTHOOT,   10
 	db 15, PINECO,     10
@@ -121,7 +123,7 @@ TreeMons6: ; b83b8
 	db  5, KAKUNA,     10
 	db -1
 
-RockMons: ; b83de
+TreeMonSet_Rock: ; b83de
 	db 90, KRABBY,     15
 	db 10, SHUCKLE,    15
 	db -1
diff --git a/data/wild/treemons_asleep.asm b/data/wild/treemons_asleep.asm
new file mode 100644
index 000000000..50c50f99f
--- /dev/null
+++ b/data/wild/treemons_asleep.asm
@@ -0,0 +1,31 @@
+; Used by CheckSleepingTreeMon
+
+AsleepTreeMonsNite:
+	db CATERPIE
+	db METAPOD
+	db BUTTERFREE
+	db WEEDLE
+	db KAKUNA
+	db BEEDRILL
+	db SPEAROW
+	db EKANS
+	db EXEGGCUTE
+	db LEDYBA
+	db AIPOM
+	db -1 ; end
+
+AsleepTreeMonsDay:
+	db VENONAT
+	db HOOTHOOT
+	db NOCTOWL
+	db SPINARAK
+	db HERACROSS
+	db -1 ; end
+
+AsleepTreeMonsMorn:
+	db VENONAT
+	db HOOTHOOT
+	db NOCTOWL
+	db SPINARAK
+	db HERACROSS
+	db -1 ; end