From 8d870d94c9f45f48419b979f7bf1c43928078eff Mon Sep 17 00:00:00 2001 From: GriffinR Date: Tue, 26 Nov 2019 17:20:08 -0500 Subject: Document Battle Arena scripts --- asm/macros/battle_frontier/battle_arena.inc | 46 ++++++++++++++++++++++++++++ asm/macros/battle_frontier/battle_palace.inc | 6 ++++ 2 files changed, 52 insertions(+) (limited to 'asm') diff --git a/asm/macros/battle_frontier/battle_arena.inc b/asm/macros/battle_frontier/battle_arena.inc index c7294145f..b54ab3c25 100644 --- a/asm/macros/battle_frontier/battle_arena.inc +++ b/asm/macros/battle_frontier/battle_arena.inc @@ -1 +1,47 @@ @ To be populated with macros for CallBattleArenaFunction + + @ Initialize the Battle Arena challenge + .macro arena_init + setvar VAR_0x8004, BATTLE_ARENA_FUNC_INIT + special CallBattleArenaFunction + .endm + + @ Unused. Get the value of some ARENA_DATA_*. See GetArenaData for the data types that can be retrieved + .macro arena_get data:req + setvar VAR_0x8004, BATTLE_ARENA_FUNC_GET_DATA + setvar VAR_0x8005, \data + special CallBattleArenaFunction + .endm + + @ Set some ARENA_DATA_* to val. See SetArenaData for the data types that can be set + .macro arena_set data:req, val:req + setvar VAR_0x8004, BATTLE_ARENA_FUNC_SET_DATA + setvar VAR_0x8005, \data + setvar VAR_0x8006, \val + special CallBattleArenaFunction + .endm + + @ Save the game and set the challenge status + .macro arena_save challengeStatus:req + setvar VAR_0x8004, BATTLE_ARENA_FUNC_SAVE + setvar VAR_0x8005, \challengeStatus + special CallBattleArenaFunction + .endm + + @ Unused. Set the reward item to give from one of two lists of possible awards, depending on streak. + .macro arena_setreward + setvar VAR_0x8004, BATTLE_ARENA_FUNC_SET_REWARD + special CallBattleArenaFunction + .endm + + @ Unused. Give the set award item to the player. TRUE if room in Bag for award, FALSE otherwise + .macro arena_givereward + setvar VAR_0x8004, BATTLE_ARENA_FUNC_GIVE_REWARD + special CallBattleArenaFunction + .endm + + @ Buffer the opponents name to STR_VAR_1 + .macro arena_gettrainername + setvar VAR_0x8004, BATTLE_ARENA_FUNC_GET_TRAINER_NAME + special CallBattleArenaFunction + .endm diff --git a/asm/macros/battle_frontier/battle_palace.inc b/asm/macros/battle_frontier/battle_palace.inc index e9a61c952..2b59fd734 100644 --- a/asm/macros/battle_frontier/battle_palace.inc +++ b/asm/macros/battle_frontier/battle_palace.inc @@ -1 +1,7 @@ @ To be populated with macros for CallBattlePalaceFunction + + @ Buffer the opponents intro speech to gStringVar4. Also used by Battle Arena and Factory + .macro palace_getopponentintro + setvar VAR_0x8004, BATTLE_PALACE_FUNC_GET_OPPONENT_INTRO + special CallBattlePalaceFunction + .endm -- cgit v1.2.3 From 70d1f54ab96235b0e0d07d40526f16449e7cb1e7 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Tue, 26 Nov 2019 17:25:29 -0500 Subject: Remove TODO comment for battle arena macros --- asm/macros/battle_frontier/battle_arena.inc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'asm') diff --git a/asm/macros/battle_frontier/battle_arena.inc b/asm/macros/battle_frontier/battle_arena.inc index b54ab3c25..1c32de981 100644 --- a/asm/macros/battle_frontier/battle_arena.inc +++ b/asm/macros/battle_frontier/battle_arena.inc @@ -1,6 +1,4 @@ -@ To be populated with macros for CallBattleArenaFunction - - @ Initialize the Battle Arena challenge + @ Initialize the Battle Arena challenge .macro arena_init setvar VAR_0x8004, BATTLE_ARENA_FUNC_INIT special CallBattleArenaFunction -- cgit v1.2.3