dionmoustos/PokemonEmeraldSafariFrontier
1
0 Fork 0
Code Issues 21 Pull Requests Actions Packages Projects Releases Wiki Activity

Continue updating event macro comments

Browse Source
This commit is contained in:
GriffinR committed 2021-11-16 13:10:23 -05:00
1 parent 04cc923d6c
commit 63c5905914
7 files changed
+149 -117
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

asm/macros/event.inc
+131 -107
View File
@@ -44,7 +44,7 @@
.4byte \destination .4byte \destination
.endm .endm
@ Jumps to the standard function at index function. @ Jumps to the script in gStdScripts at index function.
.macro gotostd function:req .macro gotostd function:req
.byte 0x08 .byte 0x08
.byte \function .byte \function
@@ -56,7 +56,7 @@
STD_OBTAIN_DECORATION = 7 STD_OBTAIN_DECORATION = 7
STD_REGISTER_MATCH_CALL = 8 STD_REGISTER_MATCH_CALL = 8
@ Executes the script in gStdScripts at index function. @ Calls the script in gStdScripts at index function.
.macro callstd function:req .macro callstd function:req
.byte 0x09 .byte 0x09
.byte \function .byte \function
@@ -318,7 +318,7 @@
.byte 0x2e .byte 0x2e
.endm .endm
@ Plays the specified (song) sound. Only one sound may play at a time, with newer ones interrupting older ones. @ Plays the specified sound. Only one sound may play at a time, with newer ones interrupting older ones.
.macro playse song:req .macro playse song:req
.byte 0x2f .byte 0x2f
.2byte \song .2byte \song
@@ -348,7 +348,8 @@
.byte \save_song .byte \save_song
.endm .endm
@ Saves the specified song to be played later. @ Saves the specified song to be played later. Saved music may be played when Overworld_PlaySpecialMapMusic is called. This occurs on
@ exiting most warps.
.macro savebgm song:req .macro savebgm song:req
.byte 0x34 .byte 0x34
.2byte \song .2byte \song
@@ -359,7 +360,7 @@
.byte 0x35 .byte 0x35
.endm .endm
@ Crossfades the currently-playng song into the specified song. @ Crossfades the currently-playing song into the specified song.
.macro fadenewbgm song:req .macro fadenewbgm song:req
.byte 0x36 .byte 0x36
.2byte \song .2byte \song
@@ -377,10 +378,10 @@
.byte \speed .byte \speed
.endm .endm
@ Helper macro for warp commands. It formats the arguments for a warp command. @ Helper macro for warp commands that formats their arguments.
@ It allows warp macros to either provide 1. a valid id for which warp location to use, @ It allows warp macros to either provide 1. a valid id for which warp location to use,
@ or 2. a pair of x/y coordinates to use. Both may be provided but at least one will be @ or 2. a pair of x/y coordinates to use. Both may be provided but at least one will be
@ ignored by SetPlayerCoordsFromWard. If none are provided it will use dummy arguments, @ ignored by SetPlayerCoordsFromWarp. If none are provided it will use dummy arguments,
@ and the warp will send the player to the center of the map. @ and the warp will send the player to the center of the map.
@ Examples of valid inputs for a warp command: @ Examples of valid inputs for a warp command:
@ - warp MAP, x, y @ - warp MAP, x, y
@@ -437,7 +438,9 @@
formatwarp \map, \a, \b, \c formatwarp \map, \a, \b, \c
.endm .endm
@ Warps the player to another map using a hole animation. @ Warps the player to another map using a hole animation. If the specified map is MAP_UNDEFINED it will instead
@ use the map set by setholewarp. In either case the target coordinates on the destination map will be the
@ player's current position.
.macro warphole map:req .macro warphole map:req
.byte 0x3c .byte 0x3c
map \map map \map
@@ -468,7 +471,9 @@
formatwarp \map, \a, \b, \c formatwarp \map, \a, \b, \c
.endm .endm
@ Sets the destination that diving or emerging from a dive will take the player to. @ Sets the destination that diving or emerging from a dive will take the player to. Note that this only
@ applies if the current map does not have a dive/emerge connection. If it does have a corresponding
@ map connection then that map and the player's current coordinates will be used as the destination instead.
@ Warp commands can be given either the id of which warp location to go to on the destination map @ Warp commands can be given either the id of which warp location to go to on the destination map
@ or a pair of x/y coordinates to go to directly on the destination map. @ or a pair of x/y coordinates to go to directly on the destination map.
.macro setdivewarp map:req, a, b, c .macro setdivewarp map:req, a, b, c
@@ -499,60 +504,60 @@
.byte 0x43 .byte 0x43
.endm .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 the specified item to the player's Bag. If the player has enough room, the item will
@ VAR_RESULT will be set to TRUE; otherwise, VAR_RESULT is set to FALSE. @ be added and VAR_RESULT will be set to TRUE; otherwise, VAR_RESULT is set to FALSE.
.macro additem index:req, quantity=1 .macro additem itemId:req, quantity=1
.byte 0x44 .byte 0x44
.2byte \index .2byte \itemId
.2byte \quantity .2byte \quantity
.endm .endm
@ Removes quantity of item index from the player's Bag. If the player has fewer than 'quantity' in their bag @ Removes quantity of the specified item from the player's Bag. If the player has fewer than 'quantity' in their bag
@ then none will be removed and VAR_RESULT will be set to FALSE. Otherwise it will be set to TRUE. @ then none will be removed and VAR_RESULT will be set to FALSE. Otherwise it will be set to TRUE.
.macro removeitem index:req, quantity=1 .macro removeitem itemId:req, quantity=1
.byte 0x45 .byte 0x45
.2byte \index .2byte \itemId
.2byte \quantity .2byte \quantity
.endm .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 the specified item. Sets VAR_RESULT to
@ TRUE if there is room, or FALSE is there is no room. @ TRUE if there is room, or FALSE is there is no room.
.macro checkitemspace index:req, quantity=1 .macro checkitemspace itemId:req, quantity=1
.byte 0x46 .byte 0x46
.2byte \index .2byte \itemId
.2byte \quantity .2byte \quantity
.endm .endm
@ Checks if the player has quantity or more of item index in their Bag. Sets VAR_RESULT to TRUE if the player has @ Checks if the player has quantity or more of the specified item in their Bag. Sets VAR_RESULT to TRUE if the player has
@ enough of the item, or FALSE if they have fewer than quantity of the item. @ enough of the item, or FALSE if they have fewer than quantity of the item.
.macro checkitem index:req, quantity=1 .macro checkitem itemId:req, quantity=1
.byte 0x47 .byte 0x47
.2byte \index .2byte \itemId
.2byte \quantity .2byte \quantity
.endm .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 is used to show the name of the proper Bag pocket when the player receives an item via callstd. @ This is used to show the name of the proper Bag pocket when the player receives an item via callstd.
.macro checkitemtype index:req .macro checkitemtype itemId:req
.byte 0x48 .byte 0x48
.2byte \index .2byte \itemId
.endm .endm
@ Adds a quantity amount of item index to the player's PC. @ Adds quantity of the specified item to the player's PC.
.macro addpcitem index:req, quantity=1 .macro addpcitem itemId:req, quantity=1
.byte 0x49 .byte 0x49
.2byte \index .2byte \itemId
.2byte \quantity .2byte \quantity
.endm .endm
@ Checks for quantity amount of item index in the player's PC. @ Checks for quantity of the specified item in the player's PC.
.macro checkpcitem index:req, quantity=1 .macro checkpcitem itemId:req, quantity=1
.byte 0x4a .byte 0x4a
.2byte \index .2byte \itemId
.2byte \quantity .2byte \quantity
.endm .endm
@ Adds decoration to the player's PC. @ Adds a decoration to the player's PC.
.macro adddecoration decoration:req .macro adddecoration decoration:req
.byte 0x4b .byte 0x4b
.2byte \decoration .2byte \decoration
@@ -570,101 +575,101 @@
.2byte \decoration .2byte \decoration
.endm .endm
@ Checks if the player has enough space in their PC to hold decoration. @ Checks if the player has enough space in their PC to hold the decoration.
@ Sets VAR_RESULT to TRUE if there is room, or FALSE is there is no room. @ Sets VAR_RESULT to TRUE if there is room, or FALSE is there is no room.
.macro checkdecorspace decoration:req .macro checkdecorspace decoration:req
.byte 0x4e .byte 0x4e
.2byte \decoration .2byte \decoration
.endm .endm
@ Applies the movement data at movements to the specified (index) Object. Also closes any standard message boxes that are still open. @ Applies the movement data at movements to the specified (localId) Object. If no map is specified, then the current map is used.
@ If no map is specified, then the current map is used. .macro applymovement localId:req, movements:req, map
.macro applymovement index:req, movements:req, map
.ifb \map .ifb \map
.byte 0x4f .byte 0x4f
.2byte \index .2byte \localId
.4byte \movements .4byte \movements
.else .else
@ Really only useful if the object has followed from one map to another (e.g. Wally during the catching event). @ Really only useful if the object has followed from one map to another (e.g. Wally during the catching event).
.byte 0x50 .byte 0x50
.2byte \index .2byte \localId
.4byte \movements .4byte \movements
map \map map \map
.endif .endif
.endm .endm
@ Blocks script execution until the movements being applied to the specified (index) Object finish. @ Blocks script execution until the movements being applied to the specified (localId) Object finish.
@ If the specified Object is 0, then the command will block script execution until all Objects @ If the specified Object is 0, then the command will block script execution until all Objects
@ affected by applymovement finish their movements. If the specified Object is not currently being @ affected by applymovement finish their movements. If the specified Object is not currently being
@ manipulated with applymovement, then this command does nothing. @ manipulated with applymovement, then this command does nothing.
@ If no map is specified, then the current map is used. @ If no map is specified, then the current map is used.
.macro waitmovement index:req, map .macro waitmovement localId:req, map
.ifb \map .ifb \map
.byte 0x51 .byte 0x51
.2byte \index .2byte \localId
.else .else
.byte 0x52 .byte 0x52
.2byte \index .2byte \localId
map \map map \map
.endif .endif
.endm .endm
@ Attempts to despawn the specified (index) Object on the specified (map_group, map_num) map. @ Attempts to despawn the specified (localId) Object on the specified (map_group, map_num) map.
@ It also sets the object's visibility flag if it has one. @ It also sets the object's visibility flag if it has one.
@ If no map is specified, then the current map is used. @ If no map is specified, then the current map is used.
.macro removeobject index:req, map .macro removeobject localId:req, map
.ifb \map .ifb \map
.byte 0x53 .byte 0x53
.2byte \index .2byte \localId
.else .else
.byte 0x54 .byte 0x54
.2byte \index .2byte \localId
map \map map \map
.endif .endif
.endm .endm
@ Attempts to spawn the specified (index) Object the specified (map_group, map_num) map. @ Attempts to spawn the specified (localId) Object the specified (map_group, map_num) map.
@ Note that unlike removeobject this does not modify the OObject's flag. @ Note that unlike removeobject this does not modify the OObject's flag.
@ If no map is specified, then the current map is used. @ If no map is specified, then the current map is used.
.macro addobject index:req, map .macro addobject localId:req, map
.ifb \map .ifb \map
.byte 0x55 .byte 0x55
.2byte \index .2byte \localId
.else .else
.byte 0x56 .byte 0x56
.2byte \index .2byte \localId
map \map map \map
.endif .endif
.endm .endm
@ Sets the specified (index) Object's position on the current map. @ Sets the specified (localId) Object's position on the current map.
.macro setobjectxy index:req, x:req, y:req .macro setobjectxy localId:req, x:req, y:req
.byte 0x57 .byte 0x57
.2byte \index .2byte \localId
.2byte \x .2byte \x
.2byte \y .2byte \y
.endm .endm
.macro showobjectat index:req, map:req .macro showobjectat localId:req, map:req
.byte 0x58 .byte 0x58
.2byte \index .2byte \localId
map \map map \map
.endm .endm
.macro hideobjectat index:req, map:req .macro hideobjectat localId:req, map:req
.byte 0x59 .byte 0x59
.2byte \index .2byte \localId
map \map map \map
.endm .endm
@ If the script was called by an Object, then that Object will turn to face toward the player. @ Turns the currently selected object (if there is one) to face the player.
.macro faceplayer .macro faceplayer
.byte 0x5a .byte 0x5a
.endm .endm
.macro turnobject index:req, direction:req @ Turns the specified object in the specified direction.
.macro turnobject localId:req, direction:req
.byte 0x5b .byte 0x5b
.2byte \index .2byte \localId
.byte \direction .byte \direction
.endm .endm
@@ -725,8 +730,8 @@
NO_MUSIC = FALSE NO_MUSIC = FALSE
@ Starts a single trainer battle, takes a trainer, intro text, loss text, and an optional event script @ Starts a single trainer battle. Takes a trainer, intro text, loss text, and an optional event script.
@ when used with an event script, you can also pass in an optional flag to disable music @ When used with an event script, you can also pass in an optional flag to disable music
.macro trainerbattle_single trainer:req, intro_text:req, lose_text:req, event_script=FALSE, music=TRUE .macro trainerbattle_single trainer:req, intro_text:req, lose_text:req, event_script=FALSE, music=TRUE
.if \event_script == FALSE .if \event_script == FALSE
trainerbattle TRAINER_BATTLE_SINGLE, \trainer, 0, \intro_text, \lose_text trainerbattle TRAINER_BATTLE_SINGLE, \trainer, 0, \intro_text, \lose_text
@@ -737,8 +742,8 @@
.endif .endif
.endm .endm
@ Starts a double trainer battle, takes a trainer, intro text, loss text, text for when you have too few pokemon @ Starts a double trainer battle. Takes a trainer, intro text, loss text, text for when you have too few pokemon
@ and an optional event script, when used with an event script you can pass in an optional flag to disable music @ and an optional event script. When used with an event script you can pass in an optional flag to disable music
.macro trainerbattle_double trainer:req, intro_text:req, lose_text:req, not_enough_pkmn_text:req, event_script=FALSE, music=TRUE .macro trainerbattle_double trainer:req, intro_text:req, lose_text:req, not_enough_pkmn_text:req, event_script=FALSE, music=TRUE
.if \event_script == FALSE .if \event_script == FALSE
trainerbattle TRAINER_BATTLE_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text trainerbattle TRAINER_BATTLE_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text
@@ -749,17 +754,17 @@
.endif .endif
.endm .endm
@ Starts a rematch battle, takes a trainer, intro text and loss text @ Starts a rematch battle. Takes a trainer, intro text and loss text
.macro trainerbattle_rematch trainer:req, intro_text:req, lose_text:req .macro trainerbattle_rematch trainer:req, intro_text:req, lose_text:req
trainerbattle TRAINER_BATTLE_REMATCH, \trainer, 0, \intro_text, \lose_text trainerbattle TRAINER_BATTLE_REMATCH, \trainer, 0, \intro_text, \lose_text
.endm .endm
@ Starts a rematch double battle, takes a trainer, intro text, loss text, and text for when you have too few pokemon @ Starts a rematch double battle. Takes a trainer, intro text, loss text, and text for when you have too few pokemon
.macro trainerbattle_rematch_double trainer:req, intro_text:req, lose_text:req, not_enough_pkmn_text:req .macro trainerbattle_rematch_double trainer:req, intro_text:req, lose_text:req, not_enough_pkmn_text:req
trainerbattle TRAINER_BATTLE_REMATCH_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text trainerbattle TRAINER_BATTLE_REMATCH_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text
.endm .endm
@ Starts a trainer battle, skipping intro text, takes a trainer and loss text @ Starts a trainer battle, skipping intro text. Takes a trainer and loss text
.macro trainerbattle_no_intro trainer:req, lose_text:req .macro trainerbattle_no_intro trainer:req, lose_text:req
trainerbattle TRAINER_BATTLE_SINGLE_NO_INTRO_TEXT, \trainer, 0, \lose_text trainerbattle TRAINER_BATTLE_SINGLE_NO_INTRO_TEXT, \trainer, 0, \lose_text
.endm .endm
@@ -781,38 +786,41 @@
.byte 0x5f .byte 0x5f
.endm .endm
@ Compares Flag (trainer + 0x500) to 1. (If the flag is set, then the trainer has been defeated by the player.) @ Checks if the trainer has been defeated by the player (by comparing the flag 'trainer + TRAINER_FLAGS_START' to TRUE).
.macro checktrainerflag trainer:req .macro checktrainerflag trainer:req
.byte 0x60 .byte 0x60
.2byte \trainer .2byte \trainer
.endm .endm
@ Sets Flag (trainer + 0x500). @ Sets the trainer flag (trainer + TRAINER_FLAGS_START) to TRUE (defeated).
.macro settrainerflag trainer:req .macro settrainerflag trainer:req
.byte 0x61 .byte 0x61
.2byte \trainer .2byte \trainer
.endm .endm
@ Clears Flag (trainer + 0x500). @ Sets the trainer flag (trainer + TRAINER_FLAGS_START) to FALSE (not defeated).
.macro cleartrainerflag trainer:req .macro cleartrainerflag trainer:req
.byte 0x62 .byte 0x62
.2byte \trainer .2byte \trainer
.endm .endm
.macro setobjectxyperm index:req, x:req, y:req @ Sets the coordinates of an object's template, so that if the sprite goes off screen
@ it'll still be there when it comes back on screen.
.macro setobjectxyperm localId:req, x:req, y:req
.byte 0x63 .byte 0x63
.2byte \index .2byte \localId
.2byte \x .2byte \x
.2byte \y .2byte \y
.endm .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. @ it'll still be there when it comes back on screen.
.macro copyobjectxytoperm index:req .macro copyobjectxytoperm localId:req
.byte 0x64 .byte 0x64
.2byte \index .2byte \localId
.endm .endm
@ Sets the movement type (MOVEMENT_TYPE_*) for an object's template.
.macro setobjectmovementtype word:req, byte:req .macro setobjectmovementtype word:req, byte:req
.byte 0x65 .byte 0x65
.2byte \word .2byte \word
@@ -826,8 +834,8 @@
.endm .endm
@ Starts displaying a standard message box containing the specified text. If text is a pointer, then the string at @ 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 @ that offset will be loaded and used. If text is NULL, then the value of script data 0 will be treated as
@ a pointer to the text. (You can use loadpointer to place a string pointer in a script bank.) @ a pointer to the text. The 'loadword 0' in msgbox sets this value, for instance.
.macro message text:req .macro message text:req
.byte 0x67 .byte 0x67
.4byte \text .4byte \text
@@ -848,17 +856,17 @@
.byte 0x6a .byte 0x6a
.endm .endm
@ Resumes normal movement for all Objects on-screen, and closes any standard message boxes that are still open. @ Resumes normal movement for all objects on-screen, and closes any standard message boxes that are still open.
.macro releaseall .macro releaseall
.byte 0x6b .byte 0x6b
.endm .endm
@ If the script was called by an Object, then that Object's movement will resume. This command also closes any standard message boxes that are still open. @ Resumes normal movement for the selected object (if there is one) and the player. Also closes any standard message boxes that are still open.
.macro release .macro release
.byte 0x6c .byte 0x6c
.endm .endm
@ Blocks script execution until the player presses any key. @ Blocks script execution until the player presses the A or B button.
.macro waitbuttonpress .macro waitbuttonpress
.byte 0x6d .byte 0x6d
.endm .endm
@@ -884,7 +892,7 @@
@ 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. @ 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 0.
@ 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. @ 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 .macro multichoicedefault x:req, y:req, multichoiceId:req, default:req, ignoreBPress:req
.byte 0x70 .byte 0x70
@@ -931,7 +939,7 @@
.byte \ignoreBPress .byte \ignoreBPress
.endm .endm
@ Displays a box containing the front sprite for the specified (species) Pokemon species. @ Displays a box containing the front sprite for the specified Pokemon species.
.macro showmonpic species:req, x:req, y:req .macro showmonpic species:req, x:req, y:req
.byte 0x75 .byte 0x75
.2byte \species .2byte \species
@@ -939,7 +947,7 @@
.byte \y .byte \y
.endm .endm
@ Hides all boxes displayed with showmonpic. @ Hides the box displayed by showmonpic.
.macro hidemonpic .macro hidemonpic
.byte 0x76 .byte 0x76
.endm .endm
@@ -950,9 +958,9 @@
.byte \winnerId .byte \winnerId
.endm .endm
@ Displays the string at pointer as braille text in a standard message box. The string must be formatted to use braille @ Displays the given string as braille text in a standard message box. The string should use the .braille directive
@ characters and needs to provide six extra starting characters that are skipped (in RS, these characters determined the @ to convert text to braille, and be preceded by brailleformat. The brailleformat data is skipped over (in RS, these
@ box's size and position, but in Emerald these are calculated automatically). @ bytes determined the box's size and position, but in Emerald these are calculated automatically).
.macro braillemessage text:req .macro braillemessage text:req
.byte 0x78 .byte 0x78
.4byte \text .4byte \text
@@ -969,38 +977,45 @@
.byte \textTop .byte \textTop
.endm .endm
@ Gives the player one of the specified (species) Pokemon at level level holding item. The trailing 0s are unused parameters @ Gives the player a Pokémon of the specified species and level, holding the specified item. The trailing 0s are unused parameters.
@ VAR_RESULT will be set to MON_GIVEN_TO_PARTY, MON_GIVEN_TO_PC, or MON_CANT_GIVE depending on the outcome.
.macro givemon species:req, level:req, item:req .macro givemon species:req, level:req, item:req
.byte 0x79 .byte 0x79
.2byte \species .2byte \species
.byte \level .byte \level
.2byte \item .2byte \item
.4byte 0x0 .4byte 0
.4byte 0x0 .4byte 0
.byte 0 .byte 0
.endm .endm
@ Gives the player an Egg of the specified species.
@ VAR_RESULT will be set to MON_GIVEN_TO_PARTY, MON_GIVEN_TO_PC, or MON_CANT_GIVE depending on the outcome.
.macro giveegg species:req .macro giveegg species:req
.byte 0x7a .byte 0x7a
.2byte \species .2byte \species
.endm .endm
.macro setmonmove index:req, slot:req, move:req @ Replaces the move at 'slot' of the Pokémon in the player's party at 'partyIndex' with the specified move.
@ If a value greater than PARTY_SIZE is given for partyIndex it will use the last Pokémon in the party instead.
@ Note that this means in vanilla a value equal to PARTY_SIZE for partyIndex will go out of bounds.
.macro setmonmove partyIndex:req, slot:req, move:req
.byte 0x7b .byte 0x7b
.byte \index .byte \partyIndex
.byte \slot .byte \slot
.2byte \move .2byte \move
.endm .endm
@ Checks if at least one Pokemon in the player's party knows the specified (index) attack. If so, VAR_RESULT is set to the @ Checks if at least one Pokemon in the player's party knows the specified move. If so, VAR_RESULT is set to the
@ (zero-indexed) slot number of the first Pokemon that knows the move. If not, VAR_RESULT is set to PARTY_SIZE. @ (zero-indexed) slot number of the first Pokemon that knows the move. If not, VAR_RESULT is set to PARTY_SIZE.
@ VAR_0x8004 is also set to this Pokemon's species. @ VAR_0x8004 is also set to this Pokemon's species.
.macro checkpartymove index:req .macro checkpartymove move:req
.byte 0x7c .byte 0x7c
.2byte \index .2byte \move
.endm .endm
@ Writes the name of the Pokemon at index species to the specified buffer. @ Writes the name of the given Pokemon species to the specified buffer.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferspeciesname out:req, species:req .macro bufferspeciesname out:req, species:req
.byte 0x7d .byte 0x7d
.byte \out .byte \out
@@ -1008,35 +1023,40 @@
.endm .endm
@ Writes the name of the species of the first Pokemon in the player's party to the specified buffer. @ Writes the name of the species of the first Pokemon in the player's party to the specified buffer.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferleadmonspeciesname out:req .macro bufferleadmonspeciesname out:req
.byte 0x7e .byte 0x7e
.byte \out .byte \out
.endm .endm
@ Writes the nickname of the Pokemon in slot slot (zero-indexed) of the player's party to the specified buffer. @ Writes the nickname of the Pokemon in 'slot' (zero-indexed) of the player's party to the specified buffer.
@ If an empty or invalid slot is specified, ten spaces ("") are written to the buffer. @ If an empty or invalid slot is specified, ten spaces ("") are written to the buffer.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferpartymonnick out:req, slot:req .macro bufferpartymonnick out:req, slot:req
.byte 0x7f .byte 0x7f
.byte \out .byte \out
.2byte \slot .2byte \slot
.endm .endm
@ Writes the name of the item at index item to the specified buffer. If the specified index is >= ITEMS_COUNT, @ Writes the name of the specified item to the specified buffer. If itemId is >= ITEMS_COUNT,
@ then the name of ITEM_NONE ("????????") is buffered instead. @ then the name of ITEM_NONE ("????????") is buffered instead.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferitemname out:req, item:req .macro bufferitemname out:req, item:req
.byte 0x80 .byte 0x80
.byte \out .byte \out
.2byte \item .2byte \item
.endm .endm
@ Writes the name of the decoration at index 'decoration' to the specified buffer. @ Writes the name of the specified decoration to the specified buffer.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferdecorationname out:req, decoration:req .macro bufferdecorationname out:req, decoration:req
.byte 0x81 .byte 0x81
.byte \out .byte \out
.2byte \decoration .2byte \decoration
.endm .endm
@ Writes the name of the move at index move to the specified buffer. @ Writes the name of the specified move to the specified buffer.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro buffermovename out:req, move:req .macro buffermovename out:req, move:req
.byte 0x82 .byte 0x82
.byte \out .byte \out
@@ -1044,34 +1064,38 @@
.endm .endm
@ Converts the value of input to a decimal string, and writes that string to the specified buffer. @ Converts the value of input to a decimal string, and writes that string to the specified buffer.
@ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro buffernumberstring out:req, input:req .macro buffernumberstring out:req, input:req
.byte 0x83 .byte 0x83
.byte \out .byte \out
.2byte \input .2byte \input
.endm .endm
@ Writes the standard string identified by index to the specified buffer. This command has no protections in place at all, @ Writes the given standard string (STDSTRING_*) to the specified buffer. Invalid std string ids are not handled.
@ so specifying an invalid standard string (e.x. 0x2B) can and usually will cause crashes or garbage characters. @ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferstdstring out:req, index:req .macro bufferstdstring out:req, index:req
.byte 0x84 .byte 0x84
.byte \out .byte \out
.2byte \index .2byte \index
.endm .endm
@ Copies the string at offset to the specified buffer. @ Copies the string at the given pointer to the specified buffer.
.macro bufferstring out:req, offset:req @ 0: STR_VAR_1, 1: STR_VAR_2, 2: STR_VAR_3
.macro bufferstring out:req, text:req
.byte 0x85 .byte 0x85
.byte \out .byte \out
.4byte \offset .4byte \text
.endm .endm
@ Opens the Pokemart system, offering the specified products for sale. @ Opens the Pokemart system, offering the specified products for sale.
@ Products should be a list of .2byte item values preceded by an .align 2
.macro pokemart products:req .macro pokemart products:req
.byte 0x86 .byte 0x86
.4byte \products .4byte \products
.endm .endm
@ Opens the Pokemart system and treats the list of items as decorations. @ Opens the Pokemart system and treats the list of items as decorations.
@ Products should be a list of .2byte decoration values preceded by an .align 2
.macro pokemartdecoration products:req .macro pokemartdecoration products:req
.byte 0x87 .byte 0x87
.4byte \products .4byte \products
@@ -1279,16 +1303,16 @@
.2byte \index .2byte \index
.endm .endm
.macro setobjectpriority index:req, map:req, priority:req .macro setobjectpriority localId:req, map:req, priority:req
.byte 0xa8 .byte 0xa8
.2byte \index .2byte \localId
map \map map \map
.byte \priority .byte \priority
.endm .endm
.macro resetobjectpriority index:req, map:req .macro resetobjectpriority localId:req, map:req
.byte 0xa9 .byte 0xa9
.2byte \index .2byte \localId
map \map map \map
.endm .endm
data/scripts/std_msgbox.inc
+6 -6
View File
@@ -1,7 +1,7 @@
Std_MsgboxNPC: Std_MsgboxNPC:
lock lock
faceplayer faceplayer
message 0x0 message NULL
waitmessage waitmessage
waitbuttonpress waitbuttonpress
release release
@@ -9,26 +9,26 @@ Std_MsgboxNPC:
Std_MsgboxSign: Std_MsgboxSign:
lockall lockall
message 0x0 message NULL
waitmessage waitmessage
waitbuttonpress waitbuttonpress
releaseall releaseall
return return
Std_MsgboxDefault: Std_MsgboxDefault:
message 0x0 message NULL
waitmessage waitmessage
waitbuttonpress waitbuttonpress
return return
Std_MsgboxYesNo: Std_MsgboxYesNo:
message 0x0 message NULL
waitmessage waitmessage
yesnobox 20, 8 yesnobox 20, 8
return return
Std_MsgboxGetPoints: Std_MsgboxGetPoints:
message 0x0 message NULL
playfanfare MUS_OBTAIN_B_POINTS playfanfare MUS_OBTAIN_B_POINTS
waitfanfare waitfanfare
waitmessage waitmessage
@@ -36,7 +36,7 @@ Std_MsgboxGetPoints:
@ Never used, pokenavcall is always used directly instead @ Never used, pokenavcall is always used directly instead
Std_MsgboxPokenav: Std_MsgboxPokenav:
pokenavcall 0x0 pokenavcall NULL
waitmessage waitmessage
return return
data/scripts/trainer_battle.inc
+1 -1
View File
@@ -136,7 +136,7 @@ EventScript_EndTrainerBattle::
end end
Std_MsgboxAutoclose:: Std_MsgboxAutoclose::
message 0x0 message NULL
waitmessage waitmessage
waitbuttonpress waitbuttonpress
release release
include/script_menu.h
+1 -1
View File
@@ -8,7 +8,7 @@ bool8 ScriptMenu_MultichoiceWithDefault(u8 left, u8 top, u8 multichoiceId, bool8
bool8 ScriptMenu_YesNo(u8 left, u8 top); bool8 ScriptMenu_YesNo(u8 left, u8 top);
bool8 ScriptMenu_MultichoiceGrid(u8 left, u8 top, u8 multichoiceId, bool8 ignoreBPress, u8 columnCount); bool8 ScriptMenu_MultichoiceGrid(u8 left, u8 top, u8 multichoiceId, bool8 ignoreBPress, u8 columnCount);
bool8 ScriptMenu_ShowPokemonPic(u16 species, u8 x, u8 y); bool8 ScriptMenu_ShowPokemonPic(u16 species, u8 x, u8 y);
bool8 (*ScriptMenu_GetPicboxWaitFunc(void))(void); bool8 (*ScriptMenu_HidePokemonPic(void))(void);
int ConvertPixelWidthToTileWidth(int width); int ConvertPixelWidthToTileWidth(int width);
u8 CreateWindowFromRect(u8 x, u8 y, u8 width, u8 height); u8 CreateWindowFromRect(u8 x, u8 y, u8 width, u8 height);
void ClearToTransparentAndRemoveWindow(u8 windowId); void ClearToTransparentAndRemoveWindow(u8 windowId);
src/scrcmd.c
+3 -1
View File
@@ -1458,7 +1458,9 @@ bool8 ScrCmd_showmonpic(struct ScriptContext *ctx)
bool8 ScrCmd_hidemonpic(struct ScriptContext *ctx) bool8 ScrCmd_hidemonpic(struct ScriptContext *ctx)
{ {
bool8 (*func)(void) = ScriptMenu_GetPicboxWaitFunc(); // The hide function returns a pointer to a function
// that returns true once the pic is hidden
bool8 (*func)(void) = ScriptMenu_HidePokemonPic();
if (func == NULL) if (func == NULL)
return FALSE; return FALSE;
src/script_menu.c
+2 -1
View File
@@ -563,6 +563,7 @@ static void Task_PokemonPicWindow(u8 taskId)
task->tState++; task->tState++;
break; break;
case 1: case 1:
// Wait until state is advanced by ScriptMenu_HidePokemonPic
break; break;
case 2: case 2:
FreeResourcesAndDestroySprite(&gSprites[task->tMonSpriteId], task->tMonSpriteId); FreeResourcesAndDestroySprite(&gSprites[task->tMonSpriteId], task->tMonSpriteId);
@@ -600,7 +601,7 @@ bool8 ScriptMenu_ShowPokemonPic(u16 species, u8 x, u8 y)
} }
} }
bool8 (*ScriptMenu_GetPicboxWaitFunc(void))(void) bool8 (*ScriptMenu_HidePokemonPic(void))(void)
{ {
u8 taskId = FindTaskIdByFunc(Task_PokemonPicWindow); u8 taskId = FindTaskIdByFunc(Task_PokemonPicWindow);
src/script_pokemon_util.c
+5
View File
@@ -150,7 +150,12 @@ void CreateScriptedWildMon(u16 species, u8 level, u16 item)
void ScriptSetMonMoveSlot(u8 monIndex, u16 move, u8 slot) void ScriptSetMonMoveSlot(u8 monIndex, u16 move, u8 slot)
{ {
// Allows monIndex to go out of bounds of gPlayerParty. Doesn't occur in vanilla
#ifdef BUGFIX
if (monIndex >= PARTY_SIZE)
#else
if (monIndex > PARTY_SIZE) if (monIndex > PARTY_SIZE)
#endif
monIndex = gPlayerPartyCount - 1; monIndex = gPlayerPartyCount - 1;
SetMonMoveSlot(&gPlayerParty[monIndex], move, slot); SetMonMoveSlot(&gPlayerParty[monIndex], move, slot);