Add some macro comments

1 files changed, 82 insertions, 82 deletions

diff --git a/asm/macros/battle_frontier/battle_pyramid.inc b/asm/macros/battle_frontier/battle_pyramid.inc
index a7b7afb89..0468e5956 100644
--- a/asm/macros/battle_frontier/battle_pyramid.inc
+++ b/asm/macros/battle_frontier/battle_pyramid.inc
@@ -1,97 +1,97 @@
-@ TODO: Add explanatory comments
+@ TODO: Add explanatory comments to macros
 
-    @ 
-    .macro pyramid_init
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_INIT
-    special CallBattlePyramidFunction 
-    .endm
+	@ Initialize the Battle Pyramid challenge
+	.macro pyramid_init
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_INIT
+	special CallBattlePyramidFunction 
+	.endm
 
-    @  
-    .macro pyramid_get data:req
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_GET_DATA
-    setvar VAR_0x8005, \data
-    special CallBattlePyramidFunction
-    .endm
+	@ Get the value of some PYRAMID_DATA_*. See GetBattlePyramidData for the data types that can be retrieved
+	.macro pyramid_get data:req
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_GET_DATA
+	setvar VAR_0x8005, \data
+	special CallBattlePyramidFunction
+	.endm
 
-    @   
-    .macro pyramid_set data:req, val:req
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_DATA
-    setvar VAR_0x8005, \data
-    setvar VAR_0x8006, \val
-    special CallBattlePyramidFunction
-    .endm
+	@ Set some PYRAMID_DATA_* to val. See SetBattlePyramidData for the data types that can be set
+	.macro pyramid_set data:req, val:req
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_DATA
+	setvar VAR_0x8005, \data
+	setvar VAR_0x8006, \val
+	special CallBattlePyramidFunction
+	.endm
 
-    @ 
-    .macro pyramid_save challengeStatus:req
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SAVE
-    setvar VAR_0x8005, \challengeStatus
-    special CallBattlePyramidFunction    
-    .endm
+	@ Save the game and set the challenge status
+	.macro pyramid_save challengeStatus:req
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SAVE
+	setvar VAR_0x8005, \challengeStatus
+	special CallBattlePyramidFunction
+	.endm
 
-    @  
-    .macro pyramid_setprize
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_PRIZE
-    special CallBattlePyramidFunction
-    .endm
+	@
+	.macro pyramid_setprize
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_PRIZE
+	special CallBattlePyramidFunction
+	.endm
 
-    @  
-    .macro pyramid_seedfloor
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SEED_FLOOR
-    special CallBattlePyramidFunction
-    .endm
+	@  
+	.macro pyramid_seedfloor
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SEED_FLOOR
+	special CallBattlePyramidFunction
+	.endm
 
-    @   
-    .macro pyramid_setitem
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_ITEM
-    special CallBattlePyramidFunction
-    .endm
+	@   
+	.macro pyramid_setitem
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_ITEM
+	special CallBattlePyramidFunction
+	.endm
 
-    @  
-    .macro pyramid_hideitem
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_HIDE_ITEM
-    special CallBattlePyramidFunction
-    .endm
+	@  
+	.macro pyramid_hideitem
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_HIDE_ITEM
+	special CallBattlePyramidFunction
+	.endm
 
-    @ 
-    .macro pyramid_inittrainers
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_INIT_TRAINERS
-    special CallBattlePyramidFunction 
-    .endm
+	@ 
+	.macro pyramid_inittrainers
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_INIT_TRAINERS
+	special CallBattlePyramidFunction 
+	.endm
 
-    @  
-    .macro pyramid_showhint
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SHOW_HINT_TEXT
-    special CallBattlePyramidFunction
-    .endm
+	@  
+	.macro pyramid_showhint
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SHOW_HINT_TEXT
+	special CallBattlePyramidFunction
+	.endm
 
-    @ VAR_RESULT is 1 if on a Pyramid floor, 2 if on the Pyramid peak   
-    .macro pyramid_inchallenge
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_IS_IN
-    special CallBattlePyramidFunction
-    .endm   
+	@ VAR_RESULT is 1 if player is on a Pyramid floor, 2 if on the Pyramid peak, 0 otherwise 
+	.macro pyramid_inchallenge
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_IS_IN
+	special CallBattlePyramidFunction
+	.endm   
 
-    @  
-    .macro pyramid_updatelight radius:req, mode:req
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_UPDATE_LIGHT
-    setvar VAR_0x8005, \radius
-    setvar VAR_0x8006, \mode
-    special CallBattlePyramidFunction
-    .endm  
+	@  
+	.macro pyramid_updatelight radius:req, mode:req
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_UPDATE_LIGHT
+	setvar VAR_0x8005, \radius
+	setvar VAR_0x8006, \mode
+	special CallBattlePyramidFunction
+	.endm  
 
-    @  
-    .macro pyramid_clearhelditems
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_CLEAR_HELD_ITEMS
-    special CallBattlePyramidFunction
-    .endm
+	@  
+	.macro pyramid_clearhelditems
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_CLEAR_HELD_ITEMS
+	special CallBattlePyramidFunction
+	.endm
 
-    @ BATTLE_PYRAMID_FUNC_SET_FLOOR_PALETTE 
-    .macro pyramid_setfloorpal
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_FLOOR_PALETTE
-    special CallBattlePyramidFunction
-    .endm             
+	@  
+	.macro pyramid_setfloorpal
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_FLOOR_PALETTE
+	special CallBattlePyramidFunction
+	.endm
 
-    @      
-    .macro pyramid_healparty
-    setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_RESTORE_PARTY
-    special CallBattlePyramidFunction 
-    .endm
+	@
+	.macro pyramid_healparty
+	setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_RESTORE_PARTY
+	special CallBattlePyramidFunction 
+	.endm