Merge pull request #443 from xCrystal/master

Misc style cleanup and documentation

12 files changed, 114 insertions, 114 deletions

diff --git a/data/battle_anims/objects.asm b/data/battle_anims/objects.asm
index 8117d8495..62ec0140e 100755
--- a/data/battle_anims/objects.asm
+++ b/data/battle_anims/objects.asm
@@ -14,7 +14,7 @@ battleanimobj: MACRO
 	db \4 ; callback
 	db \5 ; palette
 	db \6 ; tile offset
-endm
+ENDM
 
 BattleAnimObjects: ; ccb56
 ; entries correspond to ANIM_OBJ_* constants
diff --git a/data/emotes.asm b/data/emotes.asm
index af16a61c6..2e25e52b5 100644
--- a/data/emotes.asm
+++ b/data/emotes.asm
@@ -2,7 +2,7 @@ emote: MACRO
 ; graphics pointer, length, starting tile
 	dw \1
 	db \2 tiles, BANK(\1)
-	dw VTiles1 tile \3
+	dw vTiles1 tile \3
 ENDM
 
 Emotes: ; 144d
diff --git a/data/engine_flags.asm b/data/engine_flags.asm
index 8dfc251c6..9c2dda5a6 100644
--- a/data/engine_flags.asm
+++ b/data/engine_flags.asm
@@ -26,110 +26,110 @@ EngineFlags: ; 80462
 
 	engine_flag wUnusedTwoDayTimerOn, 0 ; unused, possibly related to a 2-day timer
 
-	engine_flag StatusFlags, 0 ; pokedex
-	engine_flag StatusFlags, 1 ; unown dex
-	engine_flag StatusFlags, 3 ; pokerus
-	engine_flag StatusFlags, 4 ; rocket signal on ch20
-	engine_flag StatusFlags, 6 ; credits skip
-	engine_flag StatusFlags, 7 ; bug contest on   ; $10
-	engine_flag StatusFlags2, 2 ; bug contest timer
-	engine_flag StatusFlags2, 1 ; safari zone?
-	engine_flag StatusFlags2, 0 ; rockets in radio tower
-	engine_flag StatusFlags2, 4 ; bike shop call enabled (1024 bike steps reqd)
-	engine_flag StatusFlags2, 5 ; give pokerus
-	engine_flag StatusFlags2, 6 ; berry -> berry juice when trading?
-	engine_flag StatusFlags2, 7 ; rockets in mahogany
-
-	engine_flag BikeFlags, 0 ; strength active  ; $18
-	engine_flag BikeFlags, 1 ; always on bike (cant surf)
-	engine_flag BikeFlags, 2 ; downhill (cycling road)
-
-	engine_flag JohtoBadges, 0 ; zephyrbadge
-	engine_flag JohtoBadges, 1 ; hivebadge
-	engine_flag JohtoBadges, 2 ; plainbadge
-	engine_flag JohtoBadges, 3 ; fogbadge
-	engine_flag JohtoBadges, 4 ; mineralbadge
-	engine_flag JohtoBadges, 5 ; stormbadge ; $20
-	engine_flag JohtoBadges, 6 ; glacierbadge
-	engine_flag JohtoBadges, 7 ; risingbadge
-
-	engine_flag KantoBadges, 0 ; boulderbadge
-	engine_flag KantoBadges, 1 ; cascadebadge
-	engine_flag KantoBadges, 2 ; thunderbadge
-	engine_flag KantoBadges, 3 ; rainbowbadge
-	engine_flag KantoBadges, 4 ; soulbadge
-	engine_flag KantoBadges, 5 ; marshbadge ; $28
-	engine_flag KantoBadges, 6 ; volcanobadge
-	engine_flag KantoBadges, 7 ; earthbadge
+	engine_flag wStatusFlags, 0 ; pokedex
+	engine_flag wStatusFlags, 1 ; unown dex
+	engine_flag wStatusFlags, 3 ; pokerus
+	engine_flag wStatusFlags, 4 ; rocket signal on ch20
+	engine_flag wStatusFlags, 6 ; credits skip
+	engine_flag wStatusFlags, 7 ; bug contest on   ; $10
+	engine_flag wStatusFlags2, 2 ; bug contest timer
+	engine_flag wStatusFlags2, 1 ; safari zone?
+	engine_flag wStatusFlags2, 0 ; rockets in radio tower
+	engine_flag wStatusFlags2, 4 ; bike shop call enabled (1024 bike steps reqd)
+	engine_flag wStatusFlags2, 5 ; give pokerus
+	engine_flag wStatusFlags2, 6 ; berry -> berry juice when trading?
+	engine_flag wStatusFlags2, 7 ; rockets in mahogany
+
+	engine_flag wBikeFlags, 0 ; strength active  ; $18
+	engine_flag wBikeFlags, 1 ; always on bike (cant surf)
+	engine_flag wBikeFlags, 2 ; downhill (cycling road)
+
+	engine_flag wJohtoBadges, 0 ; zephyrbadge
+	engine_flag wJohtoBadges, 1 ; hivebadge
+	engine_flag wJohtoBadges, 2 ; plainbadge
+	engine_flag wJohtoBadges, 3 ; fogbadge
+	engine_flag wJohtoBadges, 4 ; mineralbadge
+	engine_flag wJohtoBadges, 5 ; stormbadge ; $20
+	engine_flag wJohtoBadges, 6 ; glacierbadge
+	engine_flag wJohtoBadges, 7 ; risingbadge
+
+	engine_flag wKantoBadges, 0 ; boulderbadge
+	engine_flag wKantoBadges, 1 ; cascadebadge
+	engine_flag wKantoBadges, 2 ; thunderbadge
+	engine_flag wKantoBadges, 3 ; rainbowbadge
+	engine_flag wKantoBadges, 4 ; soulbadge
+	engine_flag wKantoBadges, 5 ; marshbadge ; $28
+	engine_flag wKantoBadges, 6 ; volcanobadge
+	engine_flag wKantoBadges, 7 ; earthbadge
 
 	; unown sets
-	engine_flag UnlockedUnowns, 0 ; 1
-	engine_flag UnlockedUnowns, 1 ; 2
-	engine_flag UnlockedUnowns, 2 ; 3
-	engine_flag UnlockedUnowns, 3 ; 4
-	engine_flag UnlockedUnowns, 4 ; 5
-	engine_flag UnlockedUnowns, 5 ; 6       ; $30
-	engine_flag UnlockedUnowns, 6 ; 7
-	engine_flag UnlockedUnowns, 7 ; 8
+	engine_flag wUnlockedUnowns, 0 ; 1
+	engine_flag wUnlockedUnowns, 1 ; 2
+	engine_flag wUnlockedUnowns, 2 ; 3
+	engine_flag wUnlockedUnowns, 3 ; 4
+	engine_flag wUnlockedUnowns, 4 ; 5
+	engine_flag wUnlockedUnowns, 5 ; 6       ; $30
+	engine_flag wUnlockedUnowns, 6 ; 7
+	engine_flag wUnlockedUnowns, 7 ; 8
 
 	; fly
-	engine_flag VisitedSpawns, 0     ; your house
-	engine_flag VisitedSpawns, 1     ; viridian pokecenter
-	engine_flag VisitedSpawns, 2     ; pallet
-	engine_flag VisitedSpawns, 3     ; viridian
-	engine_flag VisitedSpawns, 4     ; pewter
-	engine_flag VisitedSpawns, 5     ; cerulean ; $38
-	engine_flag VisitedSpawns, 6     ; rock tunnel
-	engine_flag VisitedSpawns, 7     ; vermilion
-	engine_flag VisitedSpawns + 1, 0 ; lavender
-	engine_flag VisitedSpawns + 1, 1 ; saffron
-	engine_flag VisitedSpawns + 1, 2 ; celadon
-	engine_flag VisitedSpawns + 1, 3 ; fuchsia
-	engine_flag VisitedSpawns + 1, 4 ; cinnabar
-	engine_flag VisitedSpawns + 1, 5 ; indigo plateau ; $40
-	engine_flag VisitedSpawns + 1, 6 ; new bark
-	engine_flag VisitedSpawns + 1, 7 ; cherrygrove
-	engine_flag VisitedSpawns + 2, 0 ; violet
-	                                 ; union cave
-	engine_flag VisitedSpawns + 2, 2 ; azalea
-	engine_flag VisitedSpawns + 2, 3 ; cianwood
-	engine_flag VisitedSpawns + 2, 4 ; goldenrod
-	engine_flag VisitedSpawns + 2, 5 ; olivine
-	engine_flag VisitedSpawns + 2, 6 ; ecruteak  ; $48
-	engine_flag VisitedSpawns + 2, 7 ; mahogany
-	engine_flag VisitedSpawns + 3, 0 ; lake of rage
-	engine_flag VisitedSpawns + 3, 1 ; blackthorn
-	engine_flag VisitedSpawns + 3, 2 ; silver cave
-	                                 ; fast ship
-	engine_flag VisitedSpawns + 3, 4 ; unused
+	engine_flag wVisitedSpawns, 0     ; your house
+	engine_flag wVisitedSpawns, 1     ; viridian pokecenter
+	engine_flag wVisitedSpawns, 2     ; pallet
+	engine_flag wVisitedSpawns, 3     ; viridian
+	engine_flag wVisitedSpawns, 4     ; pewter
+	engine_flag wVisitedSpawns, 5     ; cerulean ; $38
+	engine_flag wVisitedSpawns, 6     ; rock tunnel
+	engine_flag wVisitedSpawns, 7     ; vermilion
+	engine_flag wVisitedSpawns + 1, 0 ; lavender
+	engine_flag wVisitedSpawns + 1, 1 ; saffron
+	engine_flag wVisitedSpawns + 1, 2 ; celadon
+	engine_flag wVisitedSpawns + 1, 3 ; fuchsia
+	engine_flag wVisitedSpawns + 1, 4 ; cinnabar
+	engine_flag wVisitedSpawns + 1, 5 ; indigo plateau ; $40
+	engine_flag wVisitedSpawns + 1, 6 ; new bark
+	engine_flag wVisitedSpawns + 1, 7 ; cherrygrove
+	engine_flag wVisitedSpawns + 2, 0 ; violet
+	                                  ; union cave
+	engine_flag wVisitedSpawns + 2, 2 ; azalea
+	engine_flag wVisitedSpawns + 2, 3 ; cianwood
+	engine_flag wVisitedSpawns + 2, 4 ; goldenrod
+	engine_flag wVisitedSpawns + 2, 5 ; olivine
+	engine_flag wVisitedSpawns + 2, 6 ; ecruteak  ; $48
+	engine_flag wVisitedSpawns + 2, 7 ; mahogany
+	engine_flag wVisitedSpawns + 3, 0 ; lake of rage
+	engine_flag wVisitedSpawns + 3, 1 ; blackthorn
+	engine_flag wVisitedSpawns + 3, 2 ; silver cave
+	                                  ; fast ship
+	engine_flag wVisitedSpawns + 3, 4 ; unused
 
 	engine_flag wLuckyNumberShowFlag, 0 ; lucky number show
-	engine_flag StatusFlags2, 3 ; ????
+	engine_flag wStatusFlags2, 3 ; ????
 
-	engine_flag DailyFlags, 0 ; kurt making balls  ; $50
-	engine_flag DailyFlags, 1 ; ????
-	engine_flag DailyFlags, 2 ; special wilddata?
-	engine_flag DailyFlags, 3 ; time capsule (24h wait)
-	engine_flag DailyFlags, 4 ; all fruit trees
-	engine_flag DailyFlags, 5 ; shuckle given
-	engine_flag DailyFlags, 6 ; goldenrod underground merchant closed
-	engine_flag DailyFlags, 7 ; fought in trainer hall today
+	engine_flag wDailyFlags, 0 ; kurt making balls  ; $50
+	engine_flag wDailyFlags, 1 ; ????
+	engine_flag wDailyFlags, 2 ; special wilddata?
+	engine_flag wDailyFlags, 3 ; time capsule (24h wait)
+	engine_flag wDailyFlags, 4 ; all fruit trees
+	engine_flag wDailyFlags, 5 ; shuckle given
+	engine_flag wDailyFlags, 6 ; goldenrod underground merchant closed
+	engine_flag wDailyFlags, 7 ; fought in trainer hall today
 
-	engine_flag WeeklyFlags, 0 ; mt moon square clefairy  ; $58
-	engine_flag WeeklyFlags, 1 ; union cave lapras
-	engine_flag WeeklyFlags, 2 ; goldenrod underground haircut used
-	engine_flag WeeklyFlags, 3 ; goldenrod mall happiness event floor05 object07
-	engine_flag WeeklyFlags, 4 ; tea in blues house
-	engine_flag WeeklyFlags, 5 ; indigo plateau rival fight
-	engine_flag WeeklyFlags, 6 ; move tutor
-	engine_flag WeeklyFlags, 7 ; buenas password
+	engine_flag wWeeklyFlags, 0 ; mt moon square clefairy  ; $58
+	engine_flag wWeeklyFlags, 1 ; union cave lapras
+	engine_flag wWeeklyFlags, 2 ; goldenrod underground haircut used
+	engine_flag wWeeklyFlags, 3 ; goldenrod mall happiness event floor05 object07
+	engine_flag wWeeklyFlags, 4 ; tea in blues house
+	engine_flag wWeeklyFlags, 5 ; indigo plateau rival fight
+	engine_flag wWeeklyFlags, 6 ; move tutor
+	engine_flag wWeeklyFlags, 7 ; buenas password
 
-	engine_flag SwarmFlags, 0 ; buenas password 2
-	engine_flag SwarmFlags, 1 ; goldenrod dept store sale is on
+	engine_flag wSwarmFlags, 0 ; buenas password 2
+	engine_flag wSwarmFlags, 1 ; goldenrod dept store sale is on
 
-	engine_flag GameTimerPause, 7 ; $62
+	engine_flag wGameTimerPause, 7 ; $62
 
-	engine_flag PlayerGender, 0 ; player is female
+	engine_flag wPlayerGender, 0 ; player is female
 
 	engine_flag wCelebiEvent, 2 ; have gs ball after kurt examined it
 
@@ -200,7 +200,7 @@ EngineFlags: ; 80462
 
 	engine_flag wPlayerSpriteSetupFlags, 2 ; female player has been transformed into male
 
-	engine_flag SwarmFlags, 2 ; dunsparce swarm   ; $a0
-	engine_flag SwarmFlags, 3 ; yanma swarm
+	engine_flag wSwarmFlags, 2 ; dunsparce swarm   ; $a0
+	engine_flag wSwarmFlags, 3 ; yanma swarm
 
 ; 80648
diff --git a/data/items/mom_phone.asm b/data/items/mom_phone.asm
index 533241ca1..288a14acc 100644
--- a/data/items/mom_phone.asm
+++ b/data/items/mom_phone.asm
@@ -1,4 +1,4 @@
-momitem: macro
+momitem: MACRO
 ; money to trigger, cost, kind, item
 	dt \1
 	dt \2
diff --git a/data/map_objects.asm b/data/map_objects.asm
index af8b6d623..19a7c8d27 100755
--- a/data/map_objects.asm
+++ b/data/map_objects.asm
@@ -1,7 +1,7 @@
-sprite_movement_data: macro
+sprite_movement_data: MACRO
 	db \1, \2, \3, \4, \5
 	dn \6, 0
-endm
+ENDM
 
 SpriteMovementData:: ; 4273
 ; entries correspond to SPRITEMOVEDATA_* constants
diff --git a/data/odd_eggs.asm b/data/odd_eggs.asm
index a46d84bdc..aa7e8176b 100644
--- a/data/odd_eggs.asm
+++ b/data/odd_eggs.asm
@@ -1,7 +1,7 @@
-prob: macro
+prob: MACRO
 prob_total = prob_total + (\1)
 	dw prob_total * $ffff / 100
-endm
+ENDM
 
 OddEggProbabilities:
 prob_total = 0
diff --git a/data/palettes/town_map.asm b/data/palettes/town_map.asm
index 49fb7a9ce..696863e85 100644
--- a/data/palettes/town_map.asm
+++ b/data/palettes/town_map.asm
@@ -6,13 +6,13 @@
 	const PAL_TOWNMAP_POI      ; 4
 	const PAL_TOWNMAP_POI_MTN  ; 5
 
-townmappals: macro
+townmappals: MACRO
 rept _NARG / 2
 	dn PAL_TOWNMAP_\2, PAL_TOWNMAP_\1
 	shift
 	shift
 endr
-endm
+ENDM
 
 ; gfx/pokegear/town_map.png
 	townmappals EARTH,    EARTH,    EARTH,    MOUNTAIN, MOUNTAIN, MOUNTAIN
diff --git a/data/phone_contacts.asm b/data/phone_contacts.asm
index 0c21049bb..cfeaad8a1 100644
--- a/data/phone_contacts.asm
+++ b/data/phone_contacts.asm
@@ -1,4 +1,4 @@
-phone: macro
+phone: MACRO
 ; trainer class, trainer id, map, ?, script 1, ?, script 2
 	db  \1, \2
 	map \3
@@ -6,7 +6,7 @@ phone: macro
 	dba \5
 	db  \6
 	dba \7
-endm
+ENDM
 
 PhoneContacts: ; 9045f
 ; entries correspond to PHONE_* constants
diff --git a/data/phone_special.asm b/data/phone_special.asm
index c66c9ff77..03c27743a 100644
--- a/data/phone_special.asm
+++ b/data/phone_special.asm
@@ -1,9 +1,9 @@
-specialcall: macro
+specialcall: MACRO
 ; condition, contact, script
 	dw \1
 	db \2
 	dba \3
-endm
+ENDM
 
 SpecialPhoneCallList: ; 90627
 ; entries correspond to SPECIALCALL_* constants
diff --git a/data/unown_words.asm b/data/unown_words.asm
index e70f72356..ea8c4b2a8 100644
--- a/data/unown_words.asm
+++ b/data/unown_words.asm
@@ -1,11 +1,11 @@
-unownword: macro
+unownword: MACRO
 x = 1
 	rept STRLEN(\1)
 	db STRSUB(\1, x, 1) - $40
 x = x + 1
 	endr
 	db -1
-endm
+ENDM
 
 UnownWords: ; fba5a
 ; entries correspond to Unown forms
diff --git a/data/wild/roammon_maps.asm b/data/wild/roammon_maps.asm
index ee213bff5..c0b552b26 100644
--- a/data/wild/roammon_maps.asm
+++ b/data/wild/roammon_maps.asm
@@ -1,7 +1,7 @@
 ; Maps that roaming monsters can be on, and possible maps they can jump to.
 ; Notably missing are Route 40 and Route 41, which are water routes.
 
-roam_map: macro
+roam_map: MACRO
 ; map, # of other maps, other maps
 	map \1
 	db  \2
@@ -10,7 +10,7 @@ rept \2
 	shift
 endr
 	db 0
-endm
+ENDM
 
 RoamMaps: ; 2a40f
 	roam_map ROUTE_29, 2, ROUTE_30, ROUTE_46
diff --git a/data/wild/treemon_maps.asm b/data/wild/treemon_maps.asm
index 47491c2c9..e825930cc 100644
--- a/data/wild/treemon_maps.asm
+++ b/data/wild/treemon_maps.asm
@@ -1,7 +1,7 @@
-treemon_map: macro
+treemon_map: MACRO
 	map \1
 	db  \2 ; treemon set
-endm
+ENDM
 
 TreeMonMaps: ; b825e
 	treemon_map ROUTE_26, 4