summaryrefslogtreecommitdiff
path: root/asm/macros
diff options
context:
space:
mode:
Diffstat (limited to 'asm/macros')
-rw-r--r--asm/macros/battle_frontier/apprentice.inc6
-rw-r--r--asm/macros/battle_frontier/battle_factory.inc2
-rw-r--r--asm/macros/battle_frontier/battle_palace.inc2
-rw-r--r--asm/macros/battle_frontier/battle_pyramid.inc12
-rw-r--r--asm/macros/battle_script.inc18
-rw-r--r--asm/macros/battle_tent.inc18
-rw-r--r--asm/macros/event.inc60
7 files changed, 59 insertions, 59 deletions
diff --git a/asm/macros/battle_frontier/apprentice.inc b/asm/macros/battle_frontier/apprentice.inc
index 5d9ab8e3b..83871880b 100644
--- a/asm/macros/battle_frontier/apprentice.inc
+++ b/asm/macros/battle_frontier/apprentice.inc
@@ -53,7 +53,7 @@
special CallApprenticeFunction
.endm
- @ Always returns TRUE. No side effect. May have been for debug or dummied for some other reason
+ @ 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
@@ -109,7 +109,7 @@
special CallApprenticeFunction
.endm
- @ Set which mon the Apprentice should lead with
+ @ 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
@@ -141,7 +141,7 @@
special CallApprenticeFunction
.endm
- @ Always returns TRUE. No side effect. May have been for debug or dummied for some other reason
+ @ 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
diff --git a/asm/macros/battle_frontier/battle_factory.inc b/asm/macros/battle_frontier/battle_factory.inc
index 684eeb98d..2d49d4466 100644
--- a/asm/macros/battle_frontier/battle_factory.inc
+++ b/asm/macros/battle_frontier/battle_factory.inc
@@ -88,7 +88,7 @@
.endm
@ Return the FACTORY_STYLE_* dependent on what types of moves the opponents team has, or FACTORY_NUM_STYLES if multiple styles tie for the same amount of moves
- .macro factory_getopponentstyle
+ .macro factory_getopponentstyle
setvar VAR_0x8004, BATTLE_FACTORY_FUNC_GET_OPPONENT_STYLE
special CallBattleFactoryFunction
.endm
diff --git a/asm/macros/battle_frontier/battle_palace.inc b/asm/macros/battle_frontier/battle_palace.inc
index f326c1154..37c80467a 100644
--- a/asm/macros/battle_frontier/battle_palace.inc
+++ b/asm/macros/battle_frontier/battle_palace.inc
@@ -31,7 +31,7 @@
special CallBattlePalaceFunction
.endm
- @ Buffer the opponents intro speech to gStringVar4. Also used by Battle Arena and Factory
+ @ 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
diff --git a/asm/macros/battle_frontier/battle_pyramid.inc b/asm/macros/battle_frontier/battle_pyramid.inc
index f8141e2dd..bb5069f18 100644
--- a/asm/macros/battle_frontier/battle_pyramid.inc
+++ b/asm/macros/battle_frontier/battle_pyramid.inc
@@ -1,7 +1,7 @@
@ Initialize the Battle Pyramid challenge
.macro pyramid_init
setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_INIT
- special CallBattlePyramidFunction
+ special CallBattlePyramidFunction
.endm
@ Get the value of some PYRAMID_DATA_*. See GetBattlePyramidData for the data types that can be retrieved
@@ -59,7 +59,7 @@
@ Set the facility trainers to gBattleFrontierTrainers
.macro pyramid_settrainers
setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_SET_TRAINERS
- special CallBattlePyramidFunction
+ special CallBattlePyramidFunction
.endm
@ Show the post-battle hint text
@@ -68,11 +68,11 @@
special CallBattlePyramidFunction
.endm
- @ VAR_RESULT is 1 if player is on a Pyramid floor, 2 if on the Pyramid peak, 0 otherwise
+ @ 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
+ .endm
@ Update the light around the player. 2 different modes, for setting or incrementing light. See PYRAMID_LIGHT_*
.macro pyramid_updatelight radius:req, mode:req, sound=0xFFFF
@@ -83,7 +83,7 @@
setvar VAR_0x8007, \sound
.endif
special CallBattlePyramidFunction
- .endm
+ .endm
@ Reset the held items to what they were at the start of the challenge
.macro pyramid_clearhelditems
@@ -100,5 +100,5 @@
@ Reset sketched moves and update the party order in the saveblock
.macro pyramid_resetparty
setvar VAR_0x8004, BATTLE_PYRAMID_FUNC_RESTORE_PARTY
- special CallBattlePyramidFunction
+ special CallBattlePyramidFunction
.endm
diff --git a/asm/macros/battle_script.inc b/asm/macros/battle_script.inc
index 0f51061e8..c5bede3f5 100644
--- a/asm/macros/battle_script.inc
+++ b/asm/macros/battle_script.inc
@@ -1275,8 +1275,8 @@
various \battler, VARIOUS_UPDATE_CHOICE_MOVE_ON_LVL_UP
.endm
- .macro various7 battler:req
- various \battler, 7
+ .macro resetplayerfainted
+ various BS_ATTACKER, VARIOUS_RESET_PLAYER_FAINTED
.endm
.macro palaceflavortext battler:req
@@ -1303,12 +1303,12 @@
various \battler, VARIOUS_EMIT_YESNOBOX
.endm
- .macro various14 battler:req
- various \battler, 14
+ .macro arenadrawreftextbox
+ various BS_ATTACKER, VARIOUS_DRAW_ARENA_REF_TEXT_BOX
.endm
- .macro various15 battler:req
- various \battler, 15
+ .macro arenaerasereftextbox
+ various BS_ATTACKER, VARIOUS_ERASE_ARENA_REF_TEXT_BOX
.endm
.macro arenajudgmentstring id:req
@@ -1340,11 +1340,11 @@
.endm
.macro setalreadystatusedmoveattempt battler:req
- various \battler, 23
+ various \battler, VARIOUS_SET_ALREADY_STATUS_MOVE_ATTEMPT
.endm
- .macro various24 battler:req
- various \battler, 24
+ .macro palacetryescapestatus battler:req
+ various \battler, VARIOUS_PALACE_TRY_ESCAPE_STATUS
.endm
.macro setoutcomeonteleport battler:req
diff --git a/asm/macros/battle_tent.inc b/asm/macros/battle_tent.inc
index 663d1d344..142457ed9 100644
--- a/asm/macros/battle_tent.inc
+++ b/asm/macros/battle_tent.inc
@@ -26,7 +26,7 @@
special CallVerdanturfTentFunction
.endm
- @ Buffers the opponents intro speech to STR_VAR_4. Despite being a Verdanturf Tent function, it serves the same purpose for all 3 tents.
+ @ Buffers the opponents intro speech to STR_VAR_4. Despite being a Verdanturf Tent function, it serves the same purpose for all 3 tents.
.macro battletent_getopponentintro
setvar VAR_0x8004, VERDANTURF_TENT_FUNC_GET_OPPONENT_INTRO
special CallVerdanturfTentFunction
@@ -36,7 +36,7 @@
.macro verdanturftent_save challengeStatus:req
setvar VAR_0x8004, VERDANTURF_TENT_FUNC_SAVE
setvar VAR_0x8005, \challengeStatus
- special CallVerdanturfTentFunction
+ special CallVerdanturfTentFunction
.endm
@ Set the prize item as randomly selected from a list. Randomness unnecessary, as the list is only 1 item
@@ -49,7 +49,7 @@
.macro verdanturftent_giveprize
setvar VAR_0x8004, VERDANTURF_TENT_FUNC_GIVE_PRIZE
special CallVerdanturfTentFunction
- .endm
+ .endm
@ Fallarbor Tent
@@ -79,7 +79,7 @@
setvar VAR_0x8004, FALLARBOR_TENT_FUNC_SAVE
setvar VAR_0x8005, \challengeStatus
special CallFallarborTentFunction
- .endm
+ .endm
@ Set the prize item as randomly selected from a list. Randomness unnecessary, as the list is only 1 item
.macro fallarbortent_setrandomprize
@@ -97,7 +97,7 @@
.macro fallarbortent_getopponentname
setvar VAR_0x8004, FALLARBOR_TENT_FUNC_GET_OPPONENT_NAME
special CallFallarborTentFunction
- .endm
+ .endm
@ Slateport Tent
@@ -127,15 +127,15 @@
setvar VAR_0x8004, SLATEPORT_TENT_FUNC_SAVE
setvar VAR_0x8005, \challengeStatus
special CallSlateportTentFunction
- .endm
+ .endm
- @ Set the prize item as randomly selected from a list. Randomness unnecessary, as the list is only 1 item
+ @ Set the prize item as randomly selected from a list. Randomness unnecessary, as the list is only 1 item
.macro slateporttent_setrandomprize
setvar VAR_0x8004, SLATEPORT_TENT_FUNC_SET_RANDOM_PRIZE
special CallSlateportTentFunction
.endm
- @ Give the current prize item. FALSE if no room for prize
+ @ Give the current prize item. FALSE if no room for prize
.macro slateporttent_giveprize
setvar VAR_0x8004, SLATEPORT_TENT_FUNC_GIVE_PRIZE
special CallSlateportTentFunction
@@ -157,7 +157,7 @@
.macro slateporttent_generateopponentmons
setvar VAR_0x8004, SLATEPORT_TENT_FUNC_GENERATE_OPPONENT_MONS
special CallSlateportTentFunction
- .endm
+ .endm
@ Slateport Tent's version of factory_generaterentalmons
.macro slateporttent_generaterentalmons
diff --git a/asm/macros/event.inc b/asm/macros/event.inc
index 73aef33b5..480684ef6 100644
--- a/asm/macros/event.inc
+++ b/asm/macros/event.inc
@@ -274,8 +274,8 @@
.2byte \functionId
.endm
- @ Blocks script execution until a command or ASM code manually unblocks it. Generally used with specific
- @ commands and specials. If this command runs, and a subsequent command or piece of ASM does not unblock
+ @ Blocks script execution until a command or ASM code manually unblocks it. Generally used with specific
+ @ commands and specials. If this command runs, and a subsequent command or piece of ASM does not unblock
@ state, the script will remain blocked indefinitely (essentially a hang).
.macro waitstate
.byte 0x27
@@ -317,7 +317,7 @@
.byte 0x2d
.endm
- @ Sets the values of variables 0x8000, 0x8001, and 0x8002 to the current hour, minute, and second. In FRLG,
+ @ Sets the values of variables 0x8000, 0x8001, and 0x8002 to the current hour, minute, and second. In FRLG,
@ this command sets those variables to zero.
.macro gettime
.byte 0x2e
@@ -382,7 +382,7 @@
.byte \speed
.endm
- @ Sends the player to Warp warp on Map bank.map. If the specified warp is 0xFF,
+ @ Sends the player to Warp warp on Map bank.map. If the specified warp is 0xFF,
@ then the player will instead be sent to (X, Y) on the map.
.macro warp map:req, warp:req, X:req, Y:req
.byte 0x39
@@ -434,7 +434,7 @@
.2byte \Y
.endm
- @ Sets the warp destination that a warp to Warp 127 on Map 127.127 will connect to.
+ @ Sets the warp destination that a warp to Warp 127 on Map 127.127 will connect to.
@ Useful when a map has warps that need to go to script-controlled locations (i.e. elevators).
.macro setdynamicwarp map:req, warp:req, X:req, Y:req
.byte 0x3f
@@ -474,7 +474,7 @@
.byte 0x43
.endm
- @ Attempts to add quantity of item index to the player's Bag. If the player has enough room, the item will be added and
+ @ Attempts to add quantity of item index to the player's Bag. If the player has enough room, the item will be added and
@ VAR_RESULT will be set to TRUE; otherwise, VAR_RESULT is set to FALSE.
.macro additem index:req, quantity=1
.byte 0x44
@@ -489,7 +489,7 @@
.2byte \quantity
.endm
- @ Checks if the player has enough space in their Bag to hold quantity more of item index. Sets VAR_RESULT to
+ @ Checks if the player has enough space in their Bag to hold quantity more of item index. Sets VAR_RESULT to
@ TRUE if there is room, or FALSE is there is no room.
.macro checkitemspace index:req, quantity:req
.byte 0x46
@@ -505,7 +505,7 @@
.2byte \quantity
.endm
- @ Checks which Bag pocket the specified item belongs in, and writes the pocket value (POCKET_*) to VAR_RESULT.
+ @ Checks which Bag pocket the specified item belongs in, and writes the pocket value (POCKET_*) to VAR_RESULT.
@ This script is used to show the name of the proper Bag pocket when the player receives an item via callstd (simplified to giveitem in XSE).
.macro checkitemtype index:req
.byte 0x48
@@ -544,7 +544,7 @@
.2byte \decoration
.endm
- @ Checks if the player has enough space in their PC to hold decoration. Sets VAR_RESULT to TRUE if there is room, or
+ @ Checks if the player has enough space in their PC to hold decoration. Sets VAR_RESULT to TRUE if there is room, or
@ FALSE is there is no room. In FireRed, this command is a nop. (The argument is read, but not used for anything.)
.macro checkdecorspace decoration:req
.byte 0x4e
@@ -567,9 +567,9 @@
.endif
.endm
- @ Blocks script execution until the movements being applied to the specified (index) Object finish.
- @ If the specified Object is 0x0000, then the command will block script execution until all Objects
- @ affected by applymovement finish their movements. If the specified Object is not currently being
+ @ Blocks script execution until the movements being applied to the specified (index) Object finish.
+ @ If the specified Object is 0x0000, then the command will block script execution until all Objects
+ @ affected by applymovement finish their movements. If the specified Object is not currently being
@ manipulated with applymovement, then this command does nothing.
@ If no map is specified, then the current map is used.
.macro waitmovement index:req, map
@@ -583,8 +583,8 @@
.endif
.endm
- @ Attempts to hide the specified (index) Object on the specified (map_group, map_num) map,
- @ by setting its visibility flag if it has a valid one. If the Object does not have a valid
+ @ Attempts to hide the specified (index) Object on the specified (map_group, map_num) map,
+ @ by setting its visibility flag if it has a valid one. If the Object does not have a valid
@ visibility flag, this command does nothing.
@ If no map is specified, then the current map is used.
.macro removeobject index:req, map
@@ -598,7 +598,7 @@
.endif
.endm
- @ Unsets the specified (index) Object's visibility flag on the specified (map_group, map_num) map if it has a valid one.
+ @ Unsets the specified (index) Object's visibility flag on the specified (map_group, map_num) map if it has a valid one.
@ If the Object does not have a valid visibility flag, this command does nothing.
@ If no map is specified, then the current map is used.
.macro addobject index:req, map
@@ -740,7 +740,7 @@
.endm
- @ Starts a trainer battle using the battle information stored in RAM (usually by trainerbattle, which actually calls this
+ @ Starts a trainer battle using the battle information stored in RAM (usually by trainerbattle, which actually calls this
@ command behind-the-scenes), and blocks script execution until the battle finishes.
.macro trainerbattlebegin
.byte 0x5d
@@ -781,7 +781,7 @@
.2byte \y
.endm
- @ Copies a live object event's xy position to its template, so that if the sprite goes off screen,
+ @ Copies a live object event's xy position to its template, so that if the sprite goes off screen,
@ it'll still be there when it comes back on screen.
.macro copyobjectxytoperm index:req
.byte 0x64
@@ -794,14 +794,14 @@
.byte \byte
.endm
- @ If a standard message box (or its text) is being drawn on-screen, this command blocks script execution until the
+ @ If a standard message box (or its text) is being drawn on-screen, this command blocks script execution until the
@ box and its text have been fully drawn.
.macro waitmessage
.byte 0x66
.endm
- @ Starts displaying a standard message box containing the specified text. If text is a pointer, then the string at
- @ that offset will be loaded and used. If text is script bank 0, then the value of script bank 0 will be treated as
+ @ Starts displaying a standard message box containing the specified text. If text is a pointer, then the string at
+ @ that offset will be loaded and used. If text is script bank 0, then the value of script bank 0 will be treated as
@ a pointer to the text. (You can use loadpointer to place a string pointer in a script bank.)
.macro message text:req
.byte 0x67
@@ -846,7 +846,7 @@
.byte \y
.endm
- @ Displays a multichoice box from which the user can choose a selection, and blocks script execution until a selection is made.
+ @ Displays a multichoice box from which the user can choose a selection, and blocks script execution until a selection is made.
@ Lists of options are predefined (sMultichoiceLists) and the one to be used is specified with multichoiceId.
@ If ignoreBPress is set to a non-zero value, then the user will not be allowed to back out of the multichoice with the B button.
.macro multichoice x:req, y:req, multichoiceId:req, ignoreBPress:req
@@ -859,7 +859,7 @@
@ Displays a multichoice box from which the user can choose a selection, and blocks script execution until a selection is made.
@ Lists of options are predefined (sMultichoiceLists) and the one to be used is specified with multichoiceId.
- @ The default argument determines the initial position of the cursor when the box is first opened; it is zero-indexed, and if it is too large, it is treated as 0x00.
+ @ The default argument determines the initial position of the cursor when the box is first opened; it is zero-indexed, and if it is too large, it is treated as 0x00.
@ If ignoreBPress is set to a non-zero value, then the user will not be allowed to back out of the multichoice with the B button.
.macro multichoicedefault x:req, y:req, multichoiceId:req, default:req, ignoreBPress:req
.byte 0x70
@@ -925,8 +925,8 @@
.byte \winnerId
.endm
- @ Displays the string at pointer as braille text in a standard message box. The string must be formatted to use braille
- @ characters and needs to provide six extra starting characters that are skipped (in RS, these characters determined the
+ @ Displays the string at pointer as braille text in a standard message box. The string must be formatted to use braille
+ @ characters and needs to provide six extra starting characters that are skipped (in RS, these characters determined the
@ box's size and position, but in Emerald these are calculated automatically).
.macro braillemessage text:req
.byte 0x78
@@ -996,7 +996,7 @@
.2byte \slot
.endm
- @ Writes the name of the item at index item to the specified buffer. If the specified index is larger than
+ @ Writes the name of the item at index item to the specified buffer. If the specified index is larger than
@ the number of items in the game (0x176), the name of item 0 ("????????") is buffered instead.
.macro bufferitemname out:req, item:req
.byte 0x80
@@ -1112,7 +1112,7 @@
.byte \check
.endm
- @ If check is 0x00, this command will check if the player has money >= value; VAR_RESULT is set to TRUE if the player
+ @ If check is 0x00, this command will check if the player has money >= value; VAR_RESULT is set to TRUE if the player
@ has enough money, or FALSE if they do not.
.macro checkmoney value:req, check:req
.byte 0x92
@@ -1446,7 +1446,7 @@
.2byte \box
.endm
- @ Sets the color of the text in standard message boxes. 0x00 produces blue (male) text, 0x01 produces red (female) text,
+ @ Sets the color of the text in standard message boxes. 0x00 produces blue (male) text, 0x01 produces red (female) text,
@ 0xFF resets the color to the default for the current OW's gender, and all other values produce black text.
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
.macro textcolor color:req
@@ -1454,7 +1454,7 @@
.byte \color
.endm
- @ The exact purpose of this command is unknown, but it is related to the blue help-text box that appears on the bottom
+ @ The exact purpose of this command is unknown, but it is related to the blue help-text box that appears on the bottom
@ of the screen when the Main Menu is opened.
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
.macro loadhelp pointer:req
@@ -1643,7 +1643,7 @@
.macro goto_if_lt dest:req @ LESS THAN
goto_if 0, \dest
- .endm
+ .endm
.macro goto_if_eq dest:req @ EQUAL
goto_if 1, \dest
@@ -1677,7 +1677,7 @@
.macro call_if_lt dest:req @ LESS THAN
call_if 0, \dest
- .endm
+ .endm
.macro call_if_eq dest:req @ EQUAL
call_if 1, \dest