diff options
| author | GriffinR <griffin.richards@comcast.net> | 2019-12-11 01:09:06 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-11 01:09:06 -0500 |
| commit | 6556b556dd624964f53d76ff546589e6688412eb (patch) | |
| tree | b2e0049af7ebf824a8d264818ce3884ff6074396 /asm/macros | |
| parent | 8da7a94423b11f52a1e9ea74df3ec0e6f16e96d0 (diff) | |
| parent | 49f1a90534180445d293761e2bdac165b49319a2 (diff) | |
Merge branch 'master' into fix-eventobj
Diffstat (limited to 'asm/macros')
| -rw-r--r-- | asm/macros/battle_frontier/battle_pike.inc | 44 |
1 files changed, 21 insertions, 23 deletions
diff --git a/asm/macros/battle_frontier/battle_pike.inc b/asm/macros/battle_frontier/battle_pike.inc index d40cb0bac..30f5c88d8 100644 --- a/asm/macros/battle_frontier/battle_pike.inc +++ b/asm/macros/battle_frontier/battle_pike.inc @@ -1,6 +1,4 @@ -@ TODO: Add explanatory comments to macros - - @ + @ Set sRoomType to the next PIKE_ROOM_* id .macro pike_setnextroom setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_ROOM_TYPE special CallBattlePikeFunction @@ -25,19 +23,19 @@ special CallBattlePikeFunction .endm - @ + @ TRUE if the next room is the last (15th) room, FALSE otherwise .macro pike_isfinalroom setvar VAR_0x8004, BATTLE_PIKE_FUNC_IS_FINAL_ROOM special CallBattlePikeFunction .endm - @ + @ Set the object event gfx for the room being entered .macro pike_setroomobjects setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_ROOM_OBJECTS special CallBattlePikeFunction .endm - @ + @ Get the current room type (sRoomType) .macro pike_getroomtype setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_ROOM_TYPE special CallBattlePikeFunction @@ -62,33 +60,33 @@ special CallBattlePikeFunction .endm - @ + @ Returns the PIKE_STATUS_* to be afflicted for the status room .macro pike_getstatus setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_ROOM_STATUS special CallBattlePikeFunction .endm - @ + @ Returns the PIKE_STATUSMON_* that attacks the player for the status room .macro pike_getstatusmon setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_ROOM_STATUS_MON special CallBattlePikeFunction .endm - @ + @ Randomly heals either one or two party mons and returns the number of mons healed .macro pike_healonetwomons setvar VAR_0x8004, BATTLE_PIKE_FUNC_HEAL_ONE_TWO_MONS special CallBattlePikeFunction .endm - @ + @ Buffers a message for the lone NPC in the NPC room to gStringVar4 .macro pike_getnpcmsg setvar VAR_0x8004, BATTLE_PIKE_FUNC_BUFFER_NPC_MSG special CallBattlePikeFunction .endm - @ - .macro pike_fadescreen - setvar VAR_0x8004, BATTLE_PIKE_FUNC_STATUS_SCREEN_FADE + @ Flashes the screen 3 times for when the Dusclops/Kirlia attacks the player + .macro pike_flashscreen + setvar VAR_0x8004, BATTLE_PIKE_FUNC_STATUS_SCREEN_FLASH special CallBattlePikeFunction .endm @@ -98,31 +96,31 @@ special CallBattlePikeFunction .endm - @ TRUE if its the Pike Queens room + @ Set which room to give a hint about. TRUE if its the Pike Queens room next .macro pike_sethintroom setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_HINT_ROOM special CallBattlePikeFunction .endm - @ + @ Get PIKE_ROOM_(LEFT/CENTER/RIGHT) for which room to give a hint about .macro pike_gethintroomid setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_HINT_ROOM_ID special CallBattlePikeFunction .endm - @ + @ Get the PIKE_HINT_* to give about the next room .macro pike_gethint setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_ROOM_TYPE_HINT special CallBattlePikeFunction .endm - @ + @ Reset the frontier trainer ids for the start of the challenge .macro pike_cleartrainerids setvar VAR_0x8004, BATTLE_PIKE_FUNC_CLEAR_TRAINER_IDS special CallBattlePikeFunction .endm - @ + @ Buffer the opponents battle intro speech to gStringVar4. \trainer 0 for Trainer A, 1 for Trainer B .macro pike_gettrainerintro trainer:req setvar VAR_0x8004, BATTLE_PIKE_FUNC_GET_TRAINER_INTRO setvar VAR_0x8005, \trainer @@ -135,32 +133,32 @@ special CallBattlePikeFunction .endm - @ + @ Heal 0-2 party mons depending on which room was chosen for the Pike Queen battle. Return the number healed .macro pike_prequeenheal setvar VAR_0x8004, BATTLE_PIKE_FUNC_HEAL_MONS_BEFORE_QUEEN special CallBattlePikeFunction .endm - @ + @ When \set is TRUE, prevent healing rooms from appearing (for 1st room or when party is full health). \set FALSE to re-enable healing rooms .macro pike_nohealing set:req setvar VAR_0x8004, BATTLE_PIKE_FUNC_SET_HEAL_ROOMS_DISABLED setvar VAR_0x8005, \set special CallBattlePikeFunction .endm - @ + @ TRUE if the party is full health (full HP, PP, and no status), FALSE otherwise .macro pike_ispartyfullhealth setvar VAR_0x8004, BATTLE_PIKE_FUNC_IS_PARTY_FULL_HEALTH special CallBattlePikeFunction .endm - @ + @ Save the party held items in pikeHeldItemsBackup .macro pike_savehelditems setvar VAR_0x8004, BATTLE_PIKE_FUNC_SAVE_HELD_ITEMS special CallBattlePikeFunction .endm - @ + @ Restore the party held items from pikeHeldItemsBackup .macro pike_resethelditems setvar VAR_0x8004, BATTLE_PIKE_FUNC_RESET_HELD_ITEMS special CallBattlePikeFunction |