Split frontier macros and comment frontier_util.inc

9 files changed, 352 insertions, 0 deletions

diff --git a/asm/macros/battle_frontier/apprentice.inc b/asm/macros/battle_frontier/apprentice.inc
new file mode 100644
index 000000000..e9b098a18
--- /dev/null
+++ b/asm/macros/battle_frontier/apprentice.inc
@@ -0,0 +1,133 @@
+@ TODO: These need to have description comment
+
+	.macro apprentice_gavelvlmode
+	setvar VAR_0x8004, APPRENTICE_FUNC_GAVE_LVLMODE
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_setlvlmode lvlmode:req
+	setvar VAR_0x8004, APPRENTICE_FUNC_SET_LVLMODE
+	setorcopyvar VAR_0x8005, \lvlmode
+	addvar VAR_0x8005, 1
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_answeredquestion
+	setvar VAR_0x8004, APPRENTICE_FUNC_ANSWERED_QUESTION
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_menu  which:req
+	setvar VAR_0x8004, APPRENTICE_FUNC_MENU
+	setvar VAR_0x8005, \which
+	special CallApprenticeFunction
+	waitstate
+	.endm
+
+	.macro apprentice_shufflespecies
+	setvar VAR_0x8004, APPRENTICE_FUNC_SHUFFLE_SPECIES
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_randomizequestions
+	setvar VAR_0x8004, APPRENTICE_FUNC_RANDOMIZE_QUESTIONS
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_msg  waitbuttonpress:req, which:req
+	setvar VAR_0x8004, APPRENTICE_FUNC_PRINT_MSG
+	setvar VAR_0x8005, \waitbuttonpress
+	setvar VAR_0x8006, \which
+	special CallApprenticeFunction
+	waitstate
+	.endm
+
+	.macro apprentice_reset
+	setvar VAR_0x8004, APPRENTICE_FUNC_RESET
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_shouldcheckgone
+	setvar VAR_0x8004, APPRENTICE_FUNC_CHECK_GONE
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_getquestion
+	setvar VAR_0x8004, APPRENTICE_FUNC_GET_QUESTION
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_getnumpartymons
+	setvar VAR_0x8004, APPRENTICE_FUNC_GET_NUM_PARTY_MONS
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_setpartymon  slot:req
+	copyvar VAR_0x8006, \slot
+	setvar VAR_0x8004, APPRENTICE_FUNC_SET_PARTY_MON
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_initquestion  which:req
+	setvar VAR_0x8004, APPRENTICE_FUNC_INIT_QUESTION_DATA
+	setvar VAR_0x8005, \which
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_freequestion
+	setvar VAR_0x8004, APPRENTICE_FUNC_FREE_QUESTION_DATA
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_buff  whichstringvar:req, tobuff:req
+	setvar VAR_0x8004, APPRENTICE_FUNC_BUFFER_STRING
+	setvar VAR_0x8005, \whichstringvar
+	.if \tobuff >= VARS_START
+	copyvar VAR_0x8006, \tobuff
+	.else
+	setvar VAR_0x8006, \tobuff
+	.endif
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_setmove
+	setvar VAR_0x8004, APPRENTICE_FUNC_SET_MOVE
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_setleadmon  monId:req
+	copyvar VAR_0x8005, \monId
+	setvar VAR_0x8004, APPRENTICE_FUNC_SET_LEAD_MON
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_openbag
+	setvar VAR_0x8004, APPRENTICE_FUNC_OPEN_BAG
+	special CallApprenticeFunction
+	waitstate
+	.endm
+
+	.macro apprentice_trysetitem
+	setvar VAR_0x8004, APPRENTICE_FUNC_TRY_SET_HELD_ITEM
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_save
+	setvar VAR_0x8004, APPRENTICE_FUNC_SAVE
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_setgfx
+	setvar VAR_0x8004, APPRENTICE_FUNC_SET_GFX
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_shouldleave
+	setvar VAR_0x8004, APPRENTICE_FUNC_SHOULD_LEAVE
+	special CallApprenticeFunction
+	.endm
+
+	.macro apprentice_shiftsaved
+	setvar VAR_0x8004, APPRENTICE_FUNC_SHIFT_SAVED
+	special CallApprenticeFunction
+	.endm
diff --git a/asm/macros/battle_frontier/battle_arena.inc b/asm/macros/battle_frontier/battle_arena.inc
new file mode 100644
index 000000000..c7294145f
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_arena.inc
@@ -0,0 +1 @@
+@ To be populated with macros for CallBattleArenaFunction
diff --git a/asm/macros/battle_frontier/battle_dome.inc b/asm/macros/battle_frontier/battle_dome.inc
new file mode 100644
index 000000000..12672ea37
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_dome.inc
@@ -0,0 +1 @@
+@ To be populated with macros for CallBattleDomeFunction
diff --git a/asm/macros/battle_frontier/battle_factory.inc b/asm/macros/battle_frontier/battle_factory.inc
new file mode 100644
index 000000000..9a8879df8
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_factory.inc
@@ -0,0 +1 @@
+@ To be populated with macros for CallBattleFactoryFunction
diff --git a/asm/macros/battle_frontier/battle_palace.inc b/asm/macros/battle_frontier/battle_palace.inc
new file mode 100644
index 000000000..e9a61c952
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_palace.inc
@@ -0,0 +1 @@
+@ To be populated with macros for CallBattlePalaceFunction
diff --git a/asm/macros/battle_frontier/battle_pike.inc b/asm/macros/battle_frontier/battle_pike.inc
new file mode 100644
index 000000000..0f2d2627d
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_pike.inc
@@ -0,0 +1,54 @@
+@ To be populated with macros for CallBattlePikeFunction
+
+	.macro battlepike_getstreak
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_DATA
+	setvar VAR_0x8005, 1
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_setstreak streak:req
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_DATA
+	setvar VAR_0x8005, 1
+	.if \streak >= VARS_START
+	copyvar VAR_0x8006, \streak
+	.else
+	setvar VAR_0x8006, \streak
+	.endif
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_isfinalroom
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_IS_FINAL_ROOM
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_setroomobjects
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_ROOM_OBJECTS
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_getroomtype
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_ROOM_TYPE
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_setnextroom
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_ROOM_TYPE
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_gethint
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_ROOM_TYPE_HINT
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_nohealing set:req
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_HEALING_ROOMS_DISABLED
+	setvar VAR_0x8005, \set
+	special CallBattlePikeFunction
+	.endm
+
+	.macro battlepike_ispartyfullhealth
+	setvar VAR_0x8004, BATTLE_PIKE_FUNC_IS_PARTY_FULL_HEALTH
+	special CallBattlePikeFunction
+	.endm
diff --git a/asm/macros/battle_frontier/battle_pyramid.inc b/asm/macros/battle_frontier/battle_pyramid.inc
new file mode 100644
index 000000000..e23a819c0
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_pyramid.inc
@@ -0,0 +1 @@
+@ To be populated with macros for CallBattlePyramidFunction
diff --git a/asm/macros/battle_frontier/battle_tower.inc b/asm/macros/battle_frontier/battle_tower.inc
new file mode 100644
index 000000000..e9f8c9293
--- /dev/null
+++ b/asm/macros/battle_frontier/battle_tower.inc
@@ -0,0 +1,7 @@
+@ To be populated with macros for CallBattleTowerFunc
+
+	.macro battletower_getstreak
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_1
+	setvar VAR_0x8005, 1
+	special CallBattleTowerFunc
+	.endm
diff --git a/asm/macros/battle_frontier/frontier_util.inc b/asm/macros/battle_frontier/frontier_util.inc
new file mode 100644
index 000000000..def5b4d1c
--- /dev/null
+++ b/asm/macros/battle_frontier/frontier_util.inc
@@ -0,0 +1,153 @@
+	@ Get the status (CHALLENGE_STATUS_*) of the current challenge and store the result in VAR_TEMP_0
+	.macro frontier_getstatus
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_GET_STATUS
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Get the value of some FRONTIER_DATA_*. See GetFrontierData for the data types that can be retrieved
+	.macro frontier_get data:req
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_GET_DATA
+	setvar VAR_0x8005, \data
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Set the value of some FRONTIER_DATA_*. Some data types do not need a val argument because the value is set directly from somewhere else. See SetFrontierData for the data types that can be set
+	.macro frontier_set data:req, val=0xFFFF
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SET_DATA
+	setvar VAR_0x8005, \data
+	.if \val == 0xFFFF
+	@ no value provided
+	.elseif \val >= VARS_START
+	copyvar VAR_0x8006, \val
+	.else
+	setvar VAR_0x8006, \val
+	.endif
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Load the selected mons into gSelectedOrderFromParty and reduce the players party to these mons
+	.macro frontier_setpartyorder partySize:req
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SET_PARTY_ORDER
+	setvar VAR_0x8005, \partySize
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Performs a soft reset
+	.macro frontier_reset
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SOFT_RESET
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Loads gBattleFrontierTrainers into gFacilityTrainers
+	.macro frontier_settrainers
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SET_TRAINERS
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Sets the selected party mons in the saveblock
+	.macro frontier_saveparty
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SAVE_PARTY
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Shows the results window for the given facility and mode. Facilities with only 1 mode dont provide the mode argument
+	.macro frontier_results facility:req, mode=0xFF
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_RESULTS_WINDOW
+	setvar VAR_0x8005, \facility
+	.if \mode != 0xFF
+	setvar VAR_0x8006, \mode
+	.endif
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Checks if the Battle Frontier TV special should air, and if so attempts to set it up
+	.macro frontier_checkairshow
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_CHECK_AIR_TV_SHOW
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Get the status of the Frontier Brain (Not ready, Silver/Gold streak before symbols, Silver/Gold streak after symbols)
+	.macro frontier_getbrainstatus
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_GET_BRAIN_STATUS
+	special CallFrontierUtilFunc
+	.endm
+
+	@ TRUE if the opponent is a Frontier Brain, FALSE otherwise
+	.macro frontier_isbrain
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_IS_BRAIN
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Awards battle points depending on the current challenge
+	.macro frontier_givepoints
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_GIVE_BATTLE_POINTS
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Returns 0-2 for the number of facility symbols the player has
+	.macro frontier_getsymbols
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_GET_FACILITY_SYMBOLS
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Awards a frontier symbol depending on the current challenge
+	.macro frontier_givesymbol
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_GIVE_FACILITY_SYMBOL
+	special CallFrontierUtilFunc
+	.endm
+
+	@ TRUE if the given battleType is set in gBattleTypeFlags, FALSE otherwise
+	.macro frontier_isbattletype battleType:req
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_CHECK_BATTLE_TYPE
+	setvar VAR_0x8005, \battleType
+	special CallFrontierUtilFunc
+	.endm
+
+	@ TRUE if there are insufficient eligible party mons to participate in the challenge, and buffers caught ineligible species to STR_VAR_1. FALSE otherwise. The return value is stored in VAR_0x8004 instead, and the current level mode is expected to be in VAR_RESULT
+	.macro frontier_checkineligible
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_CHECK_INELIGIBLE
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Validates the visiting E-Reader trainer. 0 if valid, 1 if not
+	.macro frontier_checkvisittrainer
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_CHECK_VISIT_TRAINER
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Increments the current win streak by 1
+	.macro frontier_incrementstreak
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_INCREMENT_STREAK
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Resets the party held items to what they were upon entering the challenge
+	.macro frontier_restorehelditems
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_RESTORE_HELD_ITEMS
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Move the recorded battle to save data
+	.macro frontier_savebattle
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SAVE_BATTLE
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Buffer the name of gTrainerBattleOpponent_A in STR_VAR_1 (0) or STR_VAR_2 (1)
+	.macro frontier_gettrainername stringVar:req
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_BUFFER_TRAINER_NAME
+	setvar VAR_0x8005, \stringVar
+	special CallFrontierUtilFunc
+	.endm
+
+	@ If any moves were copied using Sketch during the challenge then restore them to Sketch
+	.macro frontier_resetsketch
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_RESET_SKETCH_MOVES
+	special CallFrontierUtilFunc
+	.endm
+
+	@ Set the object event gfx of the Frontier Brain for the current facility
+	.macro frontier_setbrainobj
+	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_SET_BRAIN_OBJECT
+	special CallFrontierUtilFunc
+	.endm