Add some macro comments

1 files changed, 26 insertions, 5 deletions

diff --git a/asm/macros/battle_frontier/apprentice.inc b/asm/macros/battle_frontier/apprentice.inc
index e9b098a18..5d9ab8e3b 100644
--- a/asm/macros/battle_frontier/apprentice.inc
+++ b/asm/macros/battle_frontier/apprentice.inc
@@ -1,22 +1,24 @@
-@ TODO: These need to have description comment
-
+	@ TRUE if the player has talked to the Apprentice and answered their level mode question
 	.macro apprentice_gavelvlmode
 	setvar VAR_0x8004, APPRENTICE_FUNC_GAVE_LVLMODE
 	special CallApprenticeFunction
 	.endm
 
+	@ Set the level mode the Apprentice should battle in
 	.macro apprentice_setlvlmode lvlmode:req
 	setvar VAR_0x8004, APPRENTICE_FUNC_SET_LVLMODE
 	setorcopyvar VAR_0x8005, \lvlmode
-	addvar VAR_0x8005, 1
+	addvar VAR_0x8005, 1  @ Apprentice lvl mode is +1 from regular lvl mode value
 	special CallApprenticeFunction
 	.endm
 
+	@ Question was answered, increment the number of questions answered
 	.macro apprentice_answeredquestion
 	setvar VAR_0x8004, APPRENTICE_FUNC_ANSWERED_QUESTION
 	special CallApprenticeFunction
 	.endm
 
+	@ Show the response selection box to answer the Apprentice question. Menus are defined as APPRENTICE_ASK_*
 	.macro apprentice_menu  which:req
 	setvar VAR_0x8004, APPRENTICE_FUNC_MENU
 	setvar VAR_0x8005, \which
@@ -24,16 +26,19 @@
 	waitstate
 	.endm
 
+	@ Shuffle and set the Apprentice party mons to pick between from their list of possible party species
 	.macro apprentice_shufflespecies
 	setvar VAR_0x8004, APPRENTICE_FUNC_SHUFFLE_SPECIES
 	special CallApprenticeFunction
 	.endm
 
+	@ Randomize the question data (e.g. moves to pick between) and shuffle the order to ask them in
 	.macro apprentice_randomizequestions
 	setvar VAR_0x8004, APPRENTICE_FUNC_RANDOMIZE_QUESTIONS
 	special CallApprenticeFunction
 	.endm
 
+	@ Print the APPRENTICE_MSG_* text for the current Apprentice
 	.macro apprentice_msg  waitbuttonpress:req, which:req
 	setvar VAR_0x8004, APPRENTICE_FUNC_PRINT_MSG
 	setvar VAR_0x8005, \waitbuttonpress
@@ -42,46 +47,54 @@
 	waitstate
 	.endm
 
+	@ Clear the data for the current Player Apprentice
 	.macro apprentice_reset
 	setvar VAR_0x8004, APPRENTICE_FUNC_RESET
 	special CallApprenticeFunction
 	.endm
 
+	@ Always returns TRUE. No side effect. May have been for debug or dummied for some other reason 
 	.macro apprentice_shouldcheckgone
 	setvar VAR_0x8004, APPRENTICE_FUNC_CHECK_GONE
 	special CallApprenticeFunction
 	.endm
 
+	@ Return the APPRENTICE_QUESTION_* value for the current question to ask
 	.macro apprentice_getquestion
 	setvar VAR_0x8004, APPRENTICE_FUNC_GET_QUESTION
 	special CallApprenticeFunction
 	.endm
 
+	@ Get the number of mons that have been chosen for the Apprentice's party so far
 	.macro apprentice_getnumpartymons
 	setvar VAR_0x8004, APPRENTICE_FUNC_GET_NUM_PARTY_MONS
 	special CallApprenticeFunction
 	.endm
 
+	@ Set the Apprentice party mon at the given slot. VAR_0x8005 is used implicitly as which of the 2 mons was selected
 	.macro apprentice_setpartymon  slot:req
 	copyvar VAR_0x8006, \slot
 	setvar VAR_0x8004, APPRENTICE_FUNC_SET_PARTY_MON
 	special CallApprenticeFunction
 	.endm
 
+	@ Allocate and set up data to track about the question
 	.macro apprentice_initquestion  which:req
 	setvar VAR_0x8004, APPRENTICE_FUNC_INIT_QUESTION_DATA
 	setvar VAR_0x8005, \which
 	special CallApprenticeFunction
 	.endm
 
+	@ Free allocated question data
 	.macro apprentice_freequestion
 	setvar VAR_0x8004, APPRENTICE_FUNC_FREE_QUESTION_DATA
 	special CallApprenticeFunction
 	.endm
 
-	.macro apprentice_buff  whichstringvar:req, tobuff:req
+	@ Buffer some APPRENTICE_BUFF_* string to the given stringvar (0 for STR_VAR_1, 1 for STR_VAR_2, 2 for STR_VAR_3)
+	.macro apprentice_buff  stringvar:req, tobuff:req
 	setvar VAR_0x8004, APPRENTICE_FUNC_BUFFER_STRING
-	setvar VAR_0x8005, \whichstringvar
+	setvar VAR_0x8005, \stringvar
 	.if \tobuff >= VARS_START
 	copyvar VAR_0x8006, \tobuff
 	.else
@@ -90,43 +103,51 @@
 	special CallApprenticeFunction
 	.endm
 
+	@ Set which move to use that the player chose (implicitly VAR_0x8005)
 	.macro apprentice_setmove
 	setvar VAR_0x8004, APPRENTICE_FUNC_SET_MOVE
 	special CallApprenticeFunction
 	.endm
 
+	@ Set which mon the Apprentice should lead with 
 	.macro apprentice_setleadmon  monId:req
 	copyvar VAR_0x8005, \monId
 	setvar VAR_0x8004, APPRENTICE_FUNC_SET_LEAD_MON
 	special CallApprenticeFunction
 	.endm
 
+	@ Open the Bag Menu for the player to choose an item to recommend as a held item
 	.macro apprentice_openbag
 	setvar VAR_0x8004, APPRENTICE_FUNC_OPEN_BAG
 	special CallApprenticeFunction
 	waitstate
 	.endm
 
+	@ Try and set the recommended held item. FALSE if the item has been recommended before, as Battle Frontier forbids using the same held item for multiple party mons
 	.macro apprentice_trysetitem
 	setvar VAR_0x8004, APPRENTICE_FUNC_TRY_SET_HELD_ITEM
 	special CallApprenticeFunction
 	.endm
 
+	@ Save the current Player Apprentice to the saveblock to make room for a new Apprentice
 	.macro apprentice_save
 	setvar VAR_0x8004, APPRENTICE_FUNC_SAVE
 	special CallApprenticeFunction
 	.endm
 
+	@ Set the object event gfx for the Apprentice based on their trainer class
 	.macro apprentice_setgfx
 	setvar VAR_0x8004, APPRENTICE_FUNC_SET_GFX
 	special CallApprenticeFunction
 	.endm
 
+	@ Always returns TRUE. No side effect. May have been for debug or dummied for some other reason 
 	.macro apprentice_shouldleave
 	setvar VAR_0x8004, APPRENTICE_FUNC_SHOULD_LEAVE
 	special CallApprenticeFunction
 	.endm
 
+	@ Shift the other saved Apprentices over to make room for saving a new Apprentice
 	.macro apprentice_shiftsaved
 	setvar VAR_0x8004, APPRENTICE_FUNC_SHIFT_SAVED
 	special CallApprenticeFunction