mirror of
https://github.com/Ninjdai1/pokeemerald.git
synced 2024-12-27 12:14:20 +01:00
1794 lines
46 KiB
PHP
1794 lines
46 KiB
PHP
@ Does nothing.
|
|
.macro nop
|
|
.byte 0x00
|
|
.endm
|
|
|
|
@ Does nothing.
|
|
.macro nop1
|
|
.byte 0x01
|
|
.endm
|
|
|
|
@ Terminates script execution.
|
|
.macro end
|
|
.byte 0x02
|
|
.endm
|
|
|
|
@ Jumps back to after the last-executed call statement, and continues script execution from there.
|
|
.macro return
|
|
.byte 0x03
|
|
.endm
|
|
|
|
@ Jumps to destination and continues script execution from there. The location of the calling script is remembered and can be returned to later.
|
|
.macro call destination:req
|
|
.byte 0x04
|
|
.4byte \destination
|
|
.endm
|
|
|
|
@ Jumps to destination and continues script execution from there.
|
|
.macro goto destination:req
|
|
.byte 0x05
|
|
.4byte \destination
|
|
.endm
|
|
|
|
@ If the result of the last comparison matches condition (see Comparison operators), jumps to destination and continues script execution from there.
|
|
.macro goto_if condition:req, destination:req
|
|
.byte 0x06
|
|
.byte \condition
|
|
.4byte \destination
|
|
.endm
|
|
|
|
@ If the result of the last comparison matches condition (see Comparison operators), calls destination.
|
|
.macro call_if condition:req, destination:req
|
|
.byte 0x07
|
|
.byte \condition
|
|
.4byte \destination
|
|
.endm
|
|
|
|
@ Jumps to the standard function at index function.
|
|
.macro gotostd function:req
|
|
.byte 0x08
|
|
.byte \function
|
|
.endm
|
|
|
|
@ callstd function names
|
|
STD_OBTAIN_ITEM = 0
|
|
STD_FIND_ITEM = 1
|
|
STD_OBTAIN_DECORATION = 7
|
|
STD_REGISTER_MATCH_CALL = 8
|
|
|
|
@ Calls the standard function at index function.
|
|
.macro callstd function:req
|
|
.byte 0x09
|
|
.byte \function
|
|
.endm
|
|
|
|
@ If the result of the last comparison matches condition (see Comparison operators), jumps to the standard function at index function.
|
|
.macro gotostd_if condition:req, function:req
|
|
.byte 0x0a
|
|
.byte \condition
|
|
.byte \function
|
|
.endm
|
|
|
|
@ If the result of the last comparison matches condition (see Comparison operators), calls the standard function at index function.
|
|
.macro callstd_if condition:req, function:req
|
|
.byte 0x0b
|
|
.byte \condition
|
|
.byte \function
|
|
.endm
|
|
|
|
@ Executes a script stored in a default RAM location.
|
|
.macro returnram
|
|
.byte 0x0c
|
|
.endm
|
|
|
|
@ Terminates script execution and "resets the script RAM".
|
|
.macro killscript
|
|
.byte 0x0d
|
|
.endm
|
|
|
|
@ Sets some status related to Mystery Event.
|
|
.macro setmysteryeventstatus value:req
|
|
.byte 0x0e
|
|
.byte \value
|
|
.endm
|
|
|
|
@ Sets the specified script bank to value.
|
|
.macro loadword destination:req, value:req
|
|
.byte 0x0f
|
|
.byte \destination
|
|
.4byte \value
|
|
.endm
|
|
|
|
@ Sets the specified script bank to value.
|
|
.macro loadbyte destination:req, value:req
|
|
.byte 0x10
|
|
.byte \destination
|
|
.byte \value
|
|
.endm
|
|
|
|
@ Sets the byte at offset to value.
|
|
.macro writebytetoaddr value:req, offset:req
|
|
.byte 0x11
|
|
.byte \value
|
|
.4byte \offset
|
|
.endm
|
|
|
|
@ Copies the byte value at source into the specified script bank.
|
|
.macro loadbytefromaddr destination:req, source:req
|
|
.byte 0x12
|
|
.byte \destination
|
|
.4byte \source
|
|
.endm
|
|
|
|
@ Not sure. Judging from XSE's description I think it takes the least-significant byte in bank source and writes it to destination.
|
|
.macro setptrbyte source:req, destination:req
|
|
.byte 0x13
|
|
.byte \source
|
|
.4byte \destination
|
|
.endm
|
|
|
|
@ Copies the contents of bank source into bank destination.
|
|
.macro copylocal destination:req, source:req
|
|
.byte 0x14
|
|
.byte \destination
|
|
.byte \source
|
|
.endm
|
|
|
|
@ Copies the byte at source to destination, replacing whatever byte was previously there.
|
|
.macro copybyte destination:req, source:req
|
|
.byte 0x15
|
|
.4byte \destination
|
|
.4byte \source
|
|
.endm
|
|
|
|
@ Changes the value of destination to value.
|
|
.macro setvar destination:req, value:req
|
|
.byte 0x16
|
|
.2byte \destination
|
|
.2byte \value
|
|
.endm
|
|
|
|
@ Changes the value of destination by adding value to it. Overflow is not prevented (0xFFFF + 1 = 0x0000).
|
|
.macro addvar destination:req, value:req
|
|
.byte 0x17
|
|
.2byte \destination
|
|
.2byte \value
|
|
.endm
|
|
|
|
@ Changes the value of destination by subtracting value to it. Overflow is not prevented (0x0000 - 1 = 0xFFFF).
|
|
.macro subvar destination:req, value:req
|
|
.byte 0x18
|
|
.2byte \destination
|
|
.2byte \value
|
|
.endm
|
|
|
|
@ Copies the value of source into destination.
|
|
.macro copyvar destination:req, source:req
|
|
.byte 0x19
|
|
.2byte \destination
|
|
.2byte \source
|
|
.endm
|
|
|
|
@ If source is not a variable, then this function acts like setvar. Otherwise, it acts like copyvar.
|
|
.macro setorcopyvar destination:req, source:req
|
|
.byte 0x1a
|
|
.2byte \destination
|
|
.2byte \source
|
|
.endm
|
|
|
|
@ Compares the values of script banks a and b, after forcing the values to bytes.
|
|
.macro compare_local_to_local byte1:req, byte2:req
|
|
.byte 0x1b
|
|
.byte \byte1
|
|
.byte \byte2
|
|
.endm
|
|
|
|
@ Compares the least-significant byte of the value of script bank a to a fixed byte value (b).
|
|
.macro compare_local_to_value a:req, b:req
|
|
.byte 0x1c
|
|
.byte \a
|
|
.byte \b
|
|
.endm
|
|
|
|
@ Compares the least-significant byte of the value of script bank a to the byte located at offset b.
|
|
.macro compare_local_to_addr a:req, b:req
|
|
.byte 0x1d
|
|
.byte \a
|
|
.4byte \b
|
|
.endm
|
|
|
|
@ Compares the byte located at offset a to the least-significant byte of the value of script bank b.
|
|
.macro compare_addr_to_local a:req, b:req
|
|
.byte 0x1e
|
|
.4byte \a
|
|
.byte \b
|
|
.endm
|
|
|
|
@ Compares the byte located at offset a to a fixed byte value (b).
|
|
.macro compare_addr_to_value a:req, b:req
|
|
.byte 0x1f
|
|
.4byte \a
|
|
.byte \b
|
|
.endm
|
|
|
|
@ Compares the byte located at offset a to the byte located at offset b.
|
|
.macro compare_addr_to_addr a:req, b:req
|
|
.byte 0x20
|
|
.4byte \a
|
|
.4byte \b
|
|
.endm
|
|
|
|
@ Compares the value of `var` to a fixed word value (b).
|
|
.macro compare_var_to_value var:req, value:req
|
|
.byte 0x21
|
|
.2byte \var
|
|
.2byte \value
|
|
.endm
|
|
|
|
@ Compares the value of `var1` to the value of `var2`.
|
|
.macro compare_var_to_var var1:req, var2:req
|
|
.byte 0x22
|
|
.2byte \var1
|
|
.2byte \var2
|
|
.endm
|
|
|
|
@ Generic compare macro which attempts to deduce argument types based on their values
|
|
@ Any values between 0x4000 to 0x40FF and 0x8000 to 0x8015 are considered event variable identifiers
|
|
.macro compare var:req, arg:req
|
|
.if ((\arg >= VARS_START && \arg <= VARS_END) || (\arg >= SPECIAL_VARS_START && \arg <= SPECIAL_VARS_END))
|
|
compare_var_to_var \var, \arg
|
|
.else
|
|
compare_var_to_value \var, \arg
|
|
.endif
|
|
.endm
|
|
|
|
@ Calls the native C function stored at `func`.
|
|
.macro callnative func:req
|
|
.byte 0x23
|
|
.4byte \func
|
|
.endm
|
|
|
|
@ Replaces the script with the function stored at `func`. Execution returns to the bytecode script when func returns TRUE.
|
|
.macro gotonative func:req
|
|
.byte 0x24
|
|
.4byte \func
|
|
.endm
|
|
|
|
@ Calls a special function; that is, a function designed for use by scripts and listed in a table of pointers.
|
|
.macro special function:req
|
|
.byte 0x25
|
|
.2byte SPECIAL_\function
|
|
.endm
|
|
|
|
@ Calls a special function. That function's output (if any) will be written to the variable you specify.
|
|
.macro specialvar output:req, function:req
|
|
.byte 0x26
|
|
.2byte \output
|
|
.2byte SPECIAL_\function
|
|
.endm
|
|
|
|
@ temporary solution
|
|
.macro specialvar_ output:req, functionId:req
|
|
.byte 0x26
|
|
.2byte \output
|
|
.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
|
|
@ state, the script will remain blocked indefinitely (essentially a hang).
|
|
.macro waitstate
|
|
.byte 0x27
|
|
.endm
|
|
|
|
@ Blocks script execution for frames. (Pokemon Emerald runs at just shy of 60 frames per second.)
|
|
.macro delay frames:req
|
|
.byte 0x28
|
|
.2byte \frames
|
|
.endm
|
|
|
|
@ Sets a to 1.
|
|
.macro setflag a:req
|
|
.byte 0x29
|
|
.2byte \a
|
|
.endm
|
|
|
|
@ Sets a to 0.
|
|
.macro clearflag a:req
|
|
.byte 0x2a
|
|
.2byte \a
|
|
.endm
|
|
|
|
@ Compares a to 1.
|
|
.macro checkflag a:req
|
|
.byte 0x2b
|
|
.2byte \a
|
|
.endm
|
|
|
|
@ Initializes the RTC`s local time offset to the given hour and minute. In FireRed, this command is a nop.
|
|
.macro initclock hour:req, minute:req
|
|
.byte 0x2c
|
|
.2byte \hour
|
|
.2byte \minute
|
|
.endm
|
|
|
|
@ Runs time based events. In FireRed, this command is a nop.
|
|
.macro dotimebasedevents
|
|
.byte 0x2d
|
|
.endm
|
|
|
|
@ 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
|
|
.endm
|
|
|
|
@ Plays the specified (sound_number) sound. Only one sound may play at a time, with newer ones interrupting older ones.
|
|
.macro playse sound_number:req
|
|
.byte 0x2f
|
|
.2byte \sound_number
|
|
.endm
|
|
|
|
@ Blocks script execution until the currently-playing sound (triggered by playse) finishes playing.
|
|
.macro waitse
|
|
.byte 0x30
|
|
.endm
|
|
|
|
@ Plays the specified (fanfare_number) fanfare.
|
|
.macro playfanfare fanfare_number:req
|
|
.byte 0x31
|
|
.2byte \fanfare_number
|
|
.endm
|
|
|
|
@ Blocks script execution until all currently-playing fanfares finish.
|
|
.macro waitfanfare
|
|
.byte 0x32
|
|
.endm
|
|
|
|
@ Plays the specified (song_number) song. The byte is apparently supposed to be 0x00.
|
|
.macro playbgm song_number:req, unknown:req
|
|
.byte 0x33
|
|
.2byte \song_number
|
|
.byte \unknown
|
|
.endm
|
|
|
|
@ Saves the specified (song_number) song to be played later.
|
|
.macro savebgm song_number:req
|
|
.byte 0x34
|
|
.2byte \song_number
|
|
.endm
|
|
|
|
@ Crossfades the currently-playing song into the map's default song.
|
|
.macro fadedefaultbgm
|
|
.byte 0x35
|
|
.endm
|
|
|
|
@ Crossfades the currently-playng song into the specified (song_number) song.
|
|
.macro fadenewbgm song_number:req
|
|
.byte 0x36
|
|
.2byte \song_number
|
|
.endm
|
|
|
|
@ Fades out the currently-playing song.
|
|
.macro fadeoutbgm speed:req
|
|
.byte 0x37
|
|
.byte \speed
|
|
.endm
|
|
|
|
@ Fades the previously-playing song back in.
|
|
.macro fadeinbgm speed:req
|
|
.byte 0x38
|
|
.byte \speed
|
|
.endm
|
|
|
|
@ 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
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Clone of warp that does not play a sound effect.
|
|
.macro warpsilent map:req, warp:req, X:req, Y:req
|
|
.byte 0x3a
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Clone of warp that plays a door opening animation before stepping upwards into it.
|
|
.macro warpdoor map:req, warp:req, X:req, Y:req
|
|
.byte 0x3b
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Warps the player to another map using a hole animation.
|
|
.macro warphole map:req
|
|
.byte 0x3c
|
|
map \map
|
|
.endm
|
|
|
|
@ Clone of warp that uses a teleport effect. It is apparently only used in R/S/E.
|
|
.macro warpteleport map:req, warp:req, X:req, Y:req
|
|
.byte 0x3d
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Sets the warp destination to be used later.
|
|
.macro setwarp map:req, warp:req, X:req, Y:req
|
|
.byte 0x3e
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ 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
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Sets the destination that diving or emerging from a dive will take the player to.
|
|
.macro setdivewarp map:req, warp:req, X:req, Y:req
|
|
.byte 0x40
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Sets the destination that falling into a hole will take the player to.
|
|
.macro setholewarp map:req, warp:req, X:req, Y:req
|
|
.byte 0x41
|
|
map \map
|
|
.byte \warp
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Retrieves the player's zero-indexed X- and Y-coordinates in the map, and stores them in the specified variables.
|
|
.macro getplayerxy X:req, Y:req
|
|
.byte 0x42
|
|
.2byte \X
|
|
.2byte \Y
|
|
.endm
|
|
|
|
@ Retrieves the number of Pokemon in the player's party, and stores that number in VAR_RESULT.
|
|
.macro getpartysize
|
|
.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
|
|
@ VAR_RESULT will be set to TRUE; otherwise, VAR_RESULT is set to FALSE.
|
|
.macro additem index:req, quantity=1
|
|
.byte 0x44
|
|
.2byte \index
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
@ Removes quantity of item index from the player's Bag.
|
|
.macro removeitem index:req, quantity=1
|
|
.byte 0x45
|
|
.2byte \index
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
@ 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
|
|
.2byte \index
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
@ Checks if the player has quantity or more of item index 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.
|
|
.macro checkitem index:req, quantity:req
|
|
.byte 0x47
|
|
.2byte \index
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
@ 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
|
|
.2byte \index
|
|
.endm
|
|
|
|
@ Adds a quantity amount of item index to the player's PC. Both arguments can be variables.
|
|
.macro addpcitem index:req, quantity:req
|
|
.byte 0x49
|
|
.2byte \index
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
@ Checks for quantity amount of item index in the player's PC. Both arguments can be variables.
|
|
.macro checkpcitem index:req, quantity:req
|
|
.byte 0x4a
|
|
.2byte \index
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
@ Adds decoration to the player's PC. In FireRed, this command is a nop. (The argument is read, but not used for anything.)
|
|
.macro adddecoration decoration:req
|
|
.byte 0x4b
|
|
.2byte \decoration
|
|
.endm
|
|
|
|
@ Removes a decoration from the player's PC. In FireRed, this command is a nop. (The argument is read, but not used for anything.)
|
|
.macro removedecoration decoration:req
|
|
.byte 0x4c
|
|
.2byte \decoration
|
|
.endm
|
|
|
|
@ Checks for decoration in the player's PC. In FireRed, this command is a nop. (The argument is read, but not used for anything.)
|
|
.macro checkdecor decoration:req
|
|
.byte 0x4d
|
|
.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
|
|
@ 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
|
|
.2byte \decoration
|
|
.endm
|
|
|
|
@ Applies the movement data at movements to the specified (index) Object. Also closes any standard message boxes that are still open.
|
|
@ If no map is specified, then the current map is used.
|
|
.macro applymovement index:req, movements:req, map
|
|
.ifb \map
|
|
.byte 0x4f
|
|
.2byte \index
|
|
.4byte \movements
|
|
.else
|
|
@ Really only useful if the object has followed from one map to another (e.g. Wally during the catching event).
|
|
.byte 0x50
|
|
.2byte \index
|
|
.4byte \movements
|
|
map \map
|
|
.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
|
|
@ manipulated with applymovement, then this command does nothing.
|
|
@ If no map is specified, then the current map is used.
|
|
.macro waitmovement index:req, map
|
|
.ifb \map
|
|
.byte 0x51
|
|
.2byte \index
|
|
.else
|
|
.byte 0x52
|
|
.2byte \index
|
|
map \map
|
|
.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
|
|
@ visibility flag, this command does nothing.
|
|
@ If no map is specified, then the current map is used.
|
|
.macro removeobject index:req, map
|
|
.ifb \map
|
|
.byte 0x53
|
|
.2byte \index
|
|
.else
|
|
.byte 0x54
|
|
.2byte \index
|
|
map \map
|
|
.endif
|
|
.endm
|
|
|
|
@ 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
|
|
.ifb \map
|
|
.byte 0x55
|
|
.2byte \index
|
|
.else
|
|
.byte 0x56
|
|
.2byte \index
|
|
map \map
|
|
.endif
|
|
.endm
|
|
|
|
@ Sets the specified (index) Object's position on the current map.
|
|
.macro setobjectxy index:req, x:req, y:req
|
|
.byte 0x57
|
|
.2byte \index
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
.macro showobjectat index:req, map:req
|
|
.byte 0x58
|
|
.2byte \index
|
|
map \map
|
|
.endm
|
|
|
|
.macro hideobjectat index:req, map:req
|
|
.byte 0x59
|
|
.2byte \index
|
|
map \map
|
|
.endm
|
|
|
|
@ If the script was called by an Object, then that Object will turn to face toward the metatile that the player is standing on.
|
|
.macro faceplayer
|
|
.byte 0x5a
|
|
.endm
|
|
|
|
.macro turnobject index:req, direction:req
|
|
.byte 0x5b
|
|
.2byte \index
|
|
.byte \direction
|
|
.endm
|
|
|
|
@ If the Trainer flag for Trainer index is not set, this command does absolutely nothing.
|
|
.macro trainerbattle type:req, trainer:req, local_id:req, pointer1:req, pointer2, pointer3, pointer4
|
|
.byte 0x5c
|
|
.byte \type
|
|
.2byte \trainer
|
|
.2byte \local_id
|
|
.if \type == TRAINER_BATTLE_SINGLE
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.elseif \type == TRAINER_BATTLE_CONTINUE_SCRIPT_NO_MUSIC
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.4byte \pointer3 @ event script
|
|
.elseif \type == TRAINER_BATTLE_CONTINUE_SCRIPT
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.4byte \pointer3 @ event script
|
|
.elseif \type == TRAINER_BATTLE_SINGLE_NO_INTRO_TEXT
|
|
.4byte \pointer1 @ text
|
|
.elseif \type == TRAINER_BATTLE_DOUBLE
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.4byte \pointer3 @ text
|
|
.elseif \type == TRAINER_BATTLE_REMATCH
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.elseif \type == TRAINER_BATTLE_CONTINUE_SCRIPT_DOUBLE
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.4byte \pointer3 @ text
|
|
.4byte \pointer4 @ event script
|
|
.elseif \type == TRAINER_BATTLE_REMATCH_DOUBLE
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.4byte \pointer3 @ text
|
|
.elseif \type == TRAINER_BATTLE_CONTINUE_SCRIPT_DOUBLE_NO_MUSIC
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.4byte \pointer3 @ text
|
|
.4byte \pointer4 @ event script
|
|
.elseif \type == TRAINER_BATTLE_PYRAMID
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.elseif \type == TRAINER_BATTLE_SET_TRAINER_A
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.elseif \type == TRAINER_BATTLE_SET_TRAINER_B
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.elseif \type == TRAINER_BATTLE_HILL
|
|
.4byte \pointer1 @ text
|
|
.4byte \pointer2 @ text
|
|
.endif
|
|
.endm
|
|
|
|
NO_MUSIC = FALSE
|
|
|
|
@ 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
|
|
.macro trainerbattle_single trainer:req, intro_text:req, lose_text:req, event_script=FALSE, music=TRUE
|
|
.if \event_script == FALSE
|
|
trainerbattle TRAINER_BATTLE_SINGLE, \trainer, 0, \intro_text, \lose_text
|
|
.elseif \music == TRUE
|
|
trainerbattle TRAINER_BATTLE_CONTINUE_SCRIPT, \trainer, 0, \intro_text, \lose_text, \event_script
|
|
.else
|
|
trainerbattle TRAINER_BATTLE_CONTINUE_SCRIPT_NO_MUSIC, \trainer, 0, \intro_text, \lose_text, \event_script
|
|
.endif
|
|
.endm
|
|
|
|
@ 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
|
|
.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
|
|
trainerbattle TRAINER_BATTLE_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text
|
|
.elseif \music == TRUE
|
|
trainerbattle TRAINER_BATTLE_CONTINUE_SCRIPT_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text, \event_script
|
|
.else
|
|
trainerbattle TRAINER_BATTLE_CONTINUE_SCRIPT_DOUBLE_NO_MUSIC, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text, \event_script
|
|
.endif
|
|
.endm
|
|
|
|
@ Starts a rematch battle, takes a trainer, intro text and loss text
|
|
.macro trainerbattle_rematch trainer:req, intro_text:req, lose_text:req
|
|
trainerbattle TRAINER_BATTLE_REMATCH, \trainer, 0, \intro_text, \lose_text
|
|
.endm
|
|
|
|
@ 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
|
|
trainerbattle TRAINER_BATTLE_REMATCH_DOUBLE, \trainer, 0, \intro_text, \lose_text, \not_enough_pkmn_text
|
|
.endm
|
|
|
|
@ Starts a trainer battle, skipping intro text, takes a trainer and loss text
|
|
.macro trainerbattle_no_intro trainer:req, lose_text:req
|
|
trainerbattle TRAINER_BATTLE_SINGLE_NO_INTRO_TEXT, \trainer, 0, \lose_text
|
|
.endm
|
|
|
|
|
|
@ 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
|
|
.endm
|
|
|
|
@ Goes to address after the trainerbattle command (called by the battle functions, see battle_setup.c)
|
|
.macro gotopostbattlescript
|
|
.byte 0x5e
|
|
.endm
|
|
|
|
@ Goes to address specified in the trainerbattle command (called by the battle functions, see battle_setup.c)
|
|
.macro gotobeatenscript
|
|
.byte 0x5f
|
|
.endm
|
|
|
|
@ Compares Flag (trainer + 0x500) to 1. (If the flag is set, then the trainer has been defeated by the player.)
|
|
.macro checktrainerflag trainer:req
|
|
.byte 0x60
|
|
.2byte \trainer
|
|
.endm
|
|
|
|
@ Sets Flag (trainer + 0x500).
|
|
.macro settrainerflag trainer:req
|
|
.byte 0x61
|
|
.2byte \trainer
|
|
.endm
|
|
|
|
@ Clears Flag (trainer + 0x500).
|
|
.macro cleartrainerflag trainer:req
|
|
.byte 0x62
|
|
.2byte \trainer
|
|
.endm
|
|
|
|
.macro setobjectxyperm index:req, x:req, y:req
|
|
.byte 0x63
|
|
.2byte \index
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ 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
|
|
.2byte \index
|
|
.endm
|
|
|
|
.macro setobjectmovementtype word:req, byte:req
|
|
.byte 0x65
|
|
.2byte \word
|
|
.byte \byte
|
|
.endm
|
|
|
|
@ 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
|
|
@ a pointer to the text. (You can use loadpointer to place a string pointer in a script bank.)
|
|
.macro message text:req
|
|
.byte 0x67
|
|
.4byte \text
|
|
.endm
|
|
|
|
@ Closes the current message box.
|
|
.macro closemessage
|
|
.byte 0x68
|
|
.endm
|
|
|
|
@ Ceases movement for all Objects on-screen.
|
|
.macro lockall
|
|
.byte 0x69
|
|
.endm
|
|
|
|
@ If the script was called by an Object, then that Object's movement will cease.
|
|
.macro lock
|
|
.byte 0x6a
|
|
.endm
|
|
|
|
@ Resumes normal movement for all Objects on-screen, and closes any standard message boxes that are still open.
|
|
.macro releaseall
|
|
.byte 0x6b
|
|
.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.
|
|
.macro release
|
|
.byte 0x6c
|
|
.endm
|
|
|
|
@ Blocks script execution until the player presses any key.
|
|
.macro waitbuttonpress
|
|
.byte 0x6d
|
|
.endm
|
|
|
|
@ Displays a YES/NO multichoice box at the specified coordinates, and blocks script execution until the user makes a selection.
|
|
@ Their selection is stored in VAR_RESULT as NO (0) or YES (1). Pressing B is equivalent to answering NO
|
|
.macro yesnobox x:req, y:req
|
|
.byte 0x6e
|
|
.byte \x
|
|
.byte \y
|
|
.endm
|
|
|
|
@ 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
|
|
.byte 0x6f
|
|
.byte \x
|
|
.byte \y
|
|
.byte \multichoiceId
|
|
.byte \ignoreBPress
|
|
.endm
|
|
|
|
@ 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.
|
|
@ 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
|
|
.byte \x
|
|
.byte \y
|
|
.byte \multichoiceId
|
|
.byte \default
|
|
.byte \ignoreBPress
|
|
.endm
|
|
|
|
@ 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 per_row argument determines how many list items will be shown on a single row of the box.
|
|
@ 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 multichoicegrid x:req, y:req, multichoiceId:req, per_row:req, ignoreBPress:req
|
|
.byte 0x71
|
|
.byte \x
|
|
.byte \y
|
|
.byte \multichoiceId
|
|
.byte \per_row
|
|
.byte \ignoreBPress
|
|
.endm
|
|
|
|
@ Nopped in Emerald.
|
|
.macro drawbox
|
|
.byte 0x72
|
|
.endm
|
|
|
|
@ Nopped in Emerald, but still consumes parameters.
|
|
.macro erasebox left:req, top:req, right:req, bottom:req
|
|
.byte 0x73
|
|
.byte \left
|
|
.byte \top
|
|
.byte \right
|
|
.byte \bottom
|
|
.endm
|
|
|
|
@ Nopped in Emerald, but still consumes parameters.
|
|
.macro drawboxtext left:req, top:req, multichoiceId:req, ignoreBPress:req
|
|
.byte 0x74
|
|
.byte \left
|
|
.byte \top
|
|
.byte \multichoiceId
|
|
.byte \ignoreBPress
|
|
.endm
|
|
|
|
@ Displays a box containing the front sprite for the specified (species) Pokemon species.
|
|
.macro showmonpic species:req, x:req, y:req
|
|
.byte 0x75
|
|
.2byte \species
|
|
.byte \x
|
|
.byte \y
|
|
.endm
|
|
|
|
@ Hides all boxes displayed with showmonpic.
|
|
.macro hidemonpic
|
|
.byte 0x76
|
|
.endm
|
|
|
|
@ Draws an image of the winner of the contest. In FireRed, this command is a nop. (The argument is discarded.)
|
|
.macro showcontestwinner a:req
|
|
.byte 0x77
|
|
.byte \a
|
|
.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
|
|
@ box's size and position, but in Emerald these are calculated automatically).
|
|
.macro braillemessage text:req
|
|
.byte 0x78
|
|
.4byte \text
|
|
.endm
|
|
|
|
@ Formatting for the braille window, to be put at the start of a pointer used by braillemessage.
|
|
@ These are from RS and are ignored in Emerald (see ScrCmd_braillemessage, and comment above)
|
|
.macro brailleformat winLeft:req, winTop:req, winRight:req, winBottom:req, textLeft:req, textTop:req
|
|
.byte \winLeft
|
|
.byte \winTop
|
|
.byte \winRight
|
|
.byte \winBottom
|
|
.byte \textLeft
|
|
.byte \textTop
|
|
.endm
|
|
|
|
@ Gives the player one of the specified (species) Pokemon at level level holding item. The trailing 0s are unused parameters
|
|
.macro givemon species:req, level:req, item:req
|
|
.byte 0x79
|
|
.2byte \species
|
|
.byte \level
|
|
.2byte \item
|
|
.4byte 0x0
|
|
.4byte 0x0
|
|
.byte 0
|
|
.endm
|
|
|
|
.macro giveegg species:req
|
|
.byte 0x7a
|
|
.2byte \species
|
|
.endm
|
|
|
|
.macro setmonmove index:req, slot:req, move:req
|
|
.byte 0x7b
|
|
.byte \index
|
|
.byte \slot
|
|
.2byte \move
|
|
.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
|
|
@ (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.
|
|
.macro checkpartymove index:req
|
|
.byte 0x7c
|
|
.2byte \index
|
|
.endm
|
|
|
|
@ Writes the name of the Pokemon at index species to the specified buffer.
|
|
.macro bufferspeciesname out:req, species:req
|
|
.byte 0x7d
|
|
.byte \out
|
|
.2byte \species
|
|
.endm
|
|
|
|
@ Writes the name of the species of the first Pokemon in the player's party to the specified buffer.
|
|
.macro bufferleadmonspeciesname out:req
|
|
.byte 0x7e
|
|
.byte \out
|
|
.endm
|
|
|
|
@ Writes the nickname of the Pokemon in slot 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.
|
|
.macro bufferpartymonnick out:req, slot:req
|
|
.byte 0x7f
|
|
.byte \out
|
|
.2byte \slot
|
|
.endm
|
|
|
|
@ 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
|
|
.byte \out
|
|
.2byte \item
|
|
.endm
|
|
|
|
@ Writes the name of the decoration at index decoration to the specified buffer. In FireRed, this command is a nop.
|
|
.macro bufferdecorationname out:req, decoration:req
|
|
.byte 0x81
|
|
.byte \out
|
|
.2byte \decoration
|
|
.endm
|
|
|
|
@ Writes the name of the move at index move to the specified buffer.
|
|
.macro buffermovename out:req, move:req
|
|
.byte 0x82
|
|
.byte \out
|
|
.2byte \move
|
|
.endm
|
|
|
|
@ Converts the value of input to a decimal string, and writes that string to the specified buffer.
|
|
.macro buffernumberstring out:req, input:req
|
|
.byte 0x83
|
|
.byte \out
|
|
.2byte \input
|
|
.endm
|
|
|
|
@ Writes the standard string identified by index to the specified buffer. This command has no protections in place at all,
|
|
@ so specifying an invalid standard string (e.x. 0x2B) can and usually will cause crashes or garbage characters.
|
|
.macro bufferstdstring out:req, index:req
|
|
.byte 0x84
|
|
.byte \out
|
|
.2byte \index
|
|
.endm
|
|
|
|
@ Copies the string at offset to the specified buffer.
|
|
.macro bufferstring out:req, offset:req
|
|
.byte 0x85
|
|
.byte \out
|
|
.4byte \offset
|
|
.endm
|
|
|
|
@ Opens the Pokemart system, offering the specified products for sale.
|
|
.macro pokemart products:req
|
|
.byte 0x86
|
|
.4byte \products
|
|
.endm
|
|
|
|
@ Opens the Pokemart system and treats the list of items as decorations.
|
|
.macro pokemartdecoration products:req
|
|
.byte 0x87
|
|
.4byte \products
|
|
.endm
|
|
|
|
@ Apparent clone of pokemartdecoration.
|
|
.macro pokemartdecoration2 products:req
|
|
.byte 0x88
|
|
.4byte \products
|
|
.endm
|
|
|
|
@ Starts up the slot machine minigame.
|
|
.macro playslotmachine word:req
|
|
.byte 0x89
|
|
.2byte \word
|
|
.endm
|
|
|
|
@ Sets a berry tree's specific berry and growth stage. In FireRed, this command is a nop.
|
|
.macro setberrytree tree_id:req, berry:req, growth_stage:req
|
|
.byte 0x8a
|
|
.byte \tree_id
|
|
.byte \berry
|
|
.byte \growth_stage
|
|
.endm
|
|
|
|
@ This allows you to choose a Pokemon to use in a contest. In FireRed, this command sets the byte at 0x03000EA8 to 0x01.
|
|
.macro choosecontestmon
|
|
.byte 0x8b
|
|
.endm
|
|
|
|
@ Starts a contest. In FireRed, this command is a nop.
|
|
.macro startcontest
|
|
.byte 0x8c
|
|
.endm
|
|
|
|
@ Shows the results of a contest. In FireRed, this command is a nop.
|
|
.macro showcontestresults
|
|
.byte 0x8d
|
|
.endm
|
|
|
|
@ Starts a contest over a link connection. In FireRed, this command is a nop.
|
|
.macro contestlinktransfer
|
|
.byte 0x8e
|
|
.endm
|
|
|
|
@ Stores a random integer between 0 and limit in VAR_RESULT.
|
|
.macro random limit:req
|
|
.byte 0x8f
|
|
.2byte \limit
|
|
.endm
|
|
|
|
@ If check is 0x00, this command adds value to the player's money.
|
|
.macro addmoney value:req, check:req
|
|
.byte 0x90
|
|
.4byte \value
|
|
.byte \check
|
|
.endm
|
|
|
|
@ If check is 0x00, this command subtracts value from the player's money.
|
|
.macro removemoney value:req, check:req
|
|
.byte 0x91
|
|
.4byte \value
|
|
.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
|
|
@ has enough money, or FALSE if they do not.
|
|
.macro checkmoney value:req, check:req
|
|
.byte 0x92
|
|
.4byte \value
|
|
.byte \check
|
|
.endm
|
|
|
|
@ Spawns a secondary box showing how much money the player has.
|
|
.macro showmoneybox x:req, y:req, check:req
|
|
.byte 0x93
|
|
.byte \x
|
|
.byte \y
|
|
.byte \check
|
|
.endm
|
|
|
|
@ Hides the secondary box spawned by showmoney. Consumption of the x and y arguments was dummied out.
|
|
.macro hidemoneybox
|
|
.byte 0x94
|
|
.byte 0 @ \x
|
|
.byte 0 @ \y
|
|
.endm
|
|
|
|
@ Updates the secondary box spawned by showmoney. Consumes but does not use arguments.
|
|
.macro updatemoneybox x:req, y:req
|
|
.byte 0x95
|
|
.byte \x
|
|
.byte \y
|
|
.byte 0 @ 1 = don't perform this command. Always 0 in vanilla. Why this is a thing is beyond me.
|
|
.endm
|
|
|
|
@ Gets the price reduction for the index given. In FireRed, this command is a nop.
|
|
.macro getpricereduction index:req
|
|
.byte 0x96
|
|
.2byte \index
|
|
.endm
|
|
|
|
@ Fades the screen to and from black and white. Modes are FADE_(TO/FROM)_(WHITE/BLACK)
|
|
.macro fadescreen mode:req
|
|
.byte 0x97
|
|
.byte \mode
|
|
.endm
|
|
|
|
@ Fades the screen to and from black and white. Modes are FADE_(TO/FROM)_(WHITE/BLACK)
|
|
.macro fadescreenspeed mode:req, speed:req
|
|
.byte 0x98
|
|
.byte \mode
|
|
.byte \speed
|
|
.endm
|
|
|
|
.macro setflashradius word:req
|
|
.byte 0x99
|
|
.2byte \word
|
|
.endm
|
|
|
|
.macro animateflash byte:req
|
|
.byte 0x9a
|
|
.byte \byte
|
|
.endm
|
|
|
|
.macro messageautoscroll pointer:req
|
|
.byte 0x9b
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
@ Executes the specified field move animation.
|
|
.macro dofieldeffect animation:req
|
|
.byte 0x9c
|
|
.2byte \animation
|
|
.endm
|
|
|
|
@ Sets up the field effect argument argument with the value value.
|
|
.macro setfieldeffectargument argument:req, param:req
|
|
.byte 0x9d
|
|
.byte \argument
|
|
.2byte \param
|
|
.endm
|
|
|
|
@ Blocks script execution until all playing field move animations complete.
|
|
.macro waitfieldeffect animation:req
|
|
.byte 0x9e
|
|
.2byte \animation
|
|
.endm
|
|
|
|
@ Sets which healing place the player will return to if all of the Pokemon in their party faint.
|
|
.macro setrespawn heallocation:req
|
|
.byte 0x9f
|
|
.2byte \heallocation
|
|
.endm
|
|
|
|
@ Checks the player's gender. If male, then MALE (0) is stored in VAR_RESULT. If female, then FEMALE (1) is stored in VAR_RESULT.
|
|
.macro checkplayergender
|
|
.byte 0xa0
|
|
.endm
|
|
|
|
@ Plays the specified (species) Pokemon's cry. You can use waitcry to block script execution until the sound finishes.
|
|
.macro playmoncry species:req, effect:req
|
|
.byte 0xa1
|
|
.2byte \species
|
|
.2byte \effect
|
|
.endm
|
|
|
|
@ Changes the metatile at (x, y) on the current map.
|
|
.macro setmetatile x:req, y:req, metatile_number:req, has_collision:req
|
|
.byte 0xa2
|
|
.2byte \x
|
|
.2byte \y
|
|
.2byte \metatile_number
|
|
.2byte \has_collision
|
|
.endm
|
|
|
|
@ Queues a weather change to the default weather for the map.
|
|
.macro resetweather
|
|
.byte 0xa3
|
|
.endm
|
|
|
|
@ Queues a weather change to type weather.
|
|
.macro setweather type:req
|
|
.byte 0xa4
|
|
.2byte \type
|
|
.endm
|
|
|
|
@ Executes the weather change queued with resetweather or setweather. The current weather will smoothly fade into the queued weather.
|
|
.macro doweather
|
|
.byte 0xa5
|
|
.endm
|
|
|
|
@ This command manages cases in which maps have tiles that change state when stepped on (specifically, cracked/breakable floors).
|
|
.macro setstepcallback subroutine:req
|
|
.byte 0xa6
|
|
.byte \subroutine
|
|
.endm
|
|
|
|
.macro setmaplayoutindex index:req
|
|
.byte 0xa7
|
|
.2byte \index
|
|
.endm
|
|
|
|
.macro setobjectpriority index:req, map:req, priority:req
|
|
.byte 0xa8
|
|
.2byte \index
|
|
map \map
|
|
.byte \priority
|
|
.endm
|
|
|
|
.macro resetobjectpriority index:req, map:req
|
|
.byte 0xa9
|
|
.2byte \index
|
|
map \map
|
|
.endm
|
|
|
|
.macro createvobject sprite:req, byte2:req, x:req, y:req, elevation, direction
|
|
.byte 0xaa
|
|
.byte \sprite
|
|
.byte \byte2
|
|
.2byte \x
|
|
.2byte \y
|
|
.byte \elevation
|
|
.byte \direction
|
|
.endm
|
|
|
|
.macro turnvobject index:req, direction:req
|
|
.byte 0xab
|
|
.byte \index
|
|
.byte \direction
|
|
.endm
|
|
|
|
@ Opens the door metatile at (X, Y) with an animation.
|
|
.macro opendoor x:req, y:req
|
|
.byte 0xac
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ Closes the door metatile at (X, Y) with an animation.
|
|
.macro closedoor x:req, y:req
|
|
.byte 0xad
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ Waits for the door animation started with opendoor or closedoor to finish.
|
|
.macro waitdooranim
|
|
.byte 0xae
|
|
.endm
|
|
|
|
@ Sets the door tile at (x, y) to be open without an animation.
|
|
.macro setdooropen x:req, y:req
|
|
.byte 0xaf
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ Sets the door tile at (x, y) to be closed without an animation.
|
|
.macro setdoorclosed x:req, y:req
|
|
.byte 0xb0
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ In Emerald, this command consumes its parameters and does nothing. In FireRed, this command is a nop.
|
|
.macro addelevmenuitem a:req, b:req, c:req, d:req
|
|
.byte 0xb1
|
|
.byte \a
|
|
.2byte \b
|
|
.2byte \c
|
|
.2byte \d
|
|
.endm
|
|
|
|
@ In FireRed and Emerald, this command is a nop.
|
|
.macro showelevmenu
|
|
.byte 0xb2
|
|
.endm
|
|
|
|
.macro checkcoins out:req
|
|
.byte 0xb3
|
|
.2byte \out
|
|
.endm
|
|
|
|
.macro addcoins count:req
|
|
.byte 0xb4
|
|
.2byte \count
|
|
.endm
|
|
|
|
.macro removecoins count:req
|
|
.byte 0xb5
|
|
.2byte \count
|
|
.endm
|
|
|
|
@ Prepares to start a wild battle against a species at Level level holding item. Running this command will not affect
|
|
@ normal wild battles. You start the prepared battle with dowildbattle.
|
|
.macro setwildbattle species:req, level:req, item:req
|
|
.byte 0xb6
|
|
.2byte \species
|
|
.byte \level
|
|
.2byte \item
|
|
.endm
|
|
|
|
@ Starts a wild battle against the Pokemon generated by setwildbattle. Blocks script execution until the battle finishes.
|
|
.macro dowildbattle
|
|
.byte 0xb7
|
|
.endm
|
|
|
|
.macro setvaddress pointer:req
|
|
.byte 0xb8
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vgoto pointer:req
|
|
.byte 0xb9
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vcall pointer:req
|
|
.byte 0xba
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vgoto_if byte:req, pointer:req
|
|
.byte 0xbb
|
|
.byte \byte
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vcall_if byte:req, pointer:req
|
|
.byte 0xbc
|
|
.byte \byte
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vmessage pointer:req
|
|
.byte 0xbd
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vloadptr pointer:req
|
|
.byte 0xbe
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro vbufferstring byte:req, pointer:req
|
|
.byte 0xbf
|
|
.byte \byte
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
@ Spawns a secondary box showing how many Coins the player has.
|
|
.macro showcoinsbox x:req, y:req
|
|
.byte 0xc0
|
|
.byte \x
|
|
.byte \y
|
|
.endm
|
|
|
|
@ Hides the secondary box spawned by showcoins. It consumes its arguments but doesn't use them.
|
|
.macro hidecoinsbox x:req, y:req
|
|
.byte 0xc1
|
|
.byte \x
|
|
.byte \y
|
|
.endm
|
|
|
|
@ Updates the secondary box spawned by showcoins. It consumes its arguments but doesn't use them.
|
|
.macro updatecoinsbox x:req, y:req
|
|
.byte 0xc2
|
|
.byte \x
|
|
.byte \y
|
|
.endm
|
|
|
|
@ Increases the value of the specified game stat by 1. The stat's value will not be allowed to exceed 0x00FFFFFF.
|
|
.macro incrementgamestat stat:req
|
|
.byte 0xc3
|
|
.byte \stat
|
|
.endm
|
|
|
|
@ Sets the destination that using an Escape Rope or Dig will take the player to.
|
|
.macro setescapewarp map:req, warp:req, x:req, y:req
|
|
.byte 0xc4
|
|
map \map
|
|
.byte \warp
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ Blocks script execution until cry finishes.
|
|
.macro waitmoncry
|
|
.byte 0xc5
|
|
.endm
|
|
|
|
@ Writes the name of the specified (box) PC box to the specified buffer.
|
|
.macro bufferboxname out:req, box:req
|
|
.byte 0xc6
|
|
.byte \out
|
|
.2byte \box
|
|
.endm
|
|
|
|
@ 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
|
|
.byte 0xc7
|
|
.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
|
|
@ of the screen when the Main Menu is opened.
|
|
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
|
|
.macro loadhelp pointer:req
|
|
.byte 0xc8
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
@ 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 unloadhelp
|
|
.byte 0xc9
|
|
.endm
|
|
|
|
@ After using this command, all standard message boxes will use the signpost frame.
|
|
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
|
|
.macro signmsg
|
|
.byte 0xca
|
|
.endm
|
|
|
|
@ Ends the effects of signmsg, returning message box frames to normal.
|
|
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
|
|
.macro normalmsg
|
|
.byte 0xcb
|
|
.endm
|
|
|
|
@ Compares the value of a hidden variable to a dword.
|
|
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
|
|
.macro comparehiddenvar a:req, value:req
|
|
.byte 0xcc
|
|
.byte \a
|
|
.4byte \value
|
|
.endm
|
|
|
|
@ Sets the Pokemon in the specified slot of the player party's eventLegal bit.
|
|
.macro setmoneventlegal slot:req
|
|
.byte 0xcd
|
|
.2byte \slot
|
|
.endm
|
|
|
|
@ Checks if the Pokemon in the specified slot of the player's party has its eventLegal bit set. If it isn't set,
|
|
@ VAR_RESULT is TRUE. If the bit is set (or if the specified slot is empty or invalid), VAR_RESULT is FALSE.
|
|
.macro checkmoneventlegal slot:req
|
|
.byte 0xce
|
|
.2byte \slot
|
|
.endm
|
|
|
|
@ Depending on factors I haven't managed to understand yet, this command may cause script execution to jump to the
|
|
@ offset specified by the pointer at 0x020375C0.
|
|
.macro gotoram
|
|
.byte 0xcf
|
|
.endm
|
|
|
|
@ Sets worldmapflag to 1. This allows the player to Fly to the corresponding map, if that map has a flightspot.
|
|
@ Used only in FireRed/LeafGreen, does nothing in Emerald.
|
|
.macro setworldmapflag worldmapflag:req
|
|
.byte 0xd0
|
|
.2byte \worldmapflag
|
|
.endm
|
|
|
|
@ Clone of warpteleport? It is apparently only used in FR/LG, and only with specials.[source]
|
|
.macro warpteleport2 map:req, warp:req, x:req, y:req
|
|
.byte 0xd1
|
|
map \map
|
|
.byte \warp
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
@ Changes the location where the player caught the Pokemon in the specified slot of their party.
|
|
.macro setmonmetlocation slot:req, location:req
|
|
.byte 0xd2
|
|
.2byte \slot
|
|
.byte \location
|
|
.endm
|
|
|
|
@ For the rotating tile puzzles in Mossdeep Gym/Trick House Room 7. Moves the objects on the colored puzzle
|
|
@ specified by puzzleNumber one rotation
|
|
.macro moverotatingtileobjects puzzleNumber:req
|
|
.byte 0xd3
|
|
.2byte \puzzleNumber
|
|
.endm
|
|
|
|
@ For the rotating tile puzzles in Mossdeep Gym/Trick House Room 7. Updates the facing direction of all objects on the puzzle tiles
|
|
.macro turnrotatingtileobjects
|
|
.byte 0xd4
|
|
.endm
|
|
|
|
@ For the rotating tile puzzles in Mossdeep Gym/Trick House Room 7. Allocates memory for the puzzle objects.
|
|
@ isTrickHouse is needed to determine which of the two maps the puzzle is on, in order to know where in the tileset
|
|
@ the puzzle tiles start. In FireRed, this command is a nop.
|
|
.macro initrotatingtilepuzzle isTrickHouse:req
|
|
.byte 0xd5
|
|
.2byte \isTrickHouse
|
|
.endm
|
|
|
|
@ For the rotating tile puzzles in Mossdeep Gym/Trick House Room 7. Frees the memory allocated for the puzzle objects.
|
|
.macro freerotatingtilepuzzle
|
|
.byte 0xd6
|
|
.endm
|
|
|
|
.macro warpmossdeepgym map:req, warpId:req, x:req, y:req
|
|
.byte 0xd7
|
|
map \map
|
|
.byte \warpId
|
|
.2byte \x
|
|
.2byte \y
|
|
.endm
|
|
|
|
.macro selectapproachingtrainer
|
|
.byte 0xd8
|
|
.endm
|
|
|
|
.macro lockfortrainer
|
|
.byte 0xd9
|
|
.endm
|
|
|
|
.macro closebraillemessage
|
|
.byte 0xda
|
|
.endm
|
|
|
|
.macro messageinstant pointer:req
|
|
.byte 0xdb
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro fadescreenswapbuffers mode:req
|
|
.byte 0xdc
|
|
.byte \mode
|
|
.endm
|
|
|
|
.macro buffertrainerclassname out:req, class:req
|
|
.byte 0xdd
|
|
.byte \out
|
|
.2byte \class
|
|
.endm
|
|
|
|
.macro buffertrainername out:req, trainer:req
|
|
.byte 0xde
|
|
.byte \out
|
|
.2byte \trainer
|
|
.endm
|
|
|
|
.macro pokenavcall pointer:req
|
|
.byte 0xdf
|
|
.4byte \pointer
|
|
.endm
|
|
|
|
.macro warpsootopolislegend map:req, byte:req, word1:req, word2:req
|
|
.byte 0xe0
|
|
map \map
|
|
.byte \byte
|
|
.2byte \word1
|
|
.2byte \word2
|
|
.endm
|
|
|
|
.macro buffercontesttypestring out:req, word:req
|
|
.byte 0xe1
|
|
.byte \out
|
|
.2byte \word
|
|
.endm
|
|
|
|
@ Writes the name of the specified (item) item to the specified buffer. If the specified item is a Berry (0x85 - 0xAE) or
|
|
@ Poke Ball (0x4) and if the quantity is 2 or more, the buffered string will be pluralized ("IES" or "S" appended).
|
|
@ If the specified item is the Enigma Berry, I have no idea what this command does (but testing showed no pluralization).
|
|
@ If the specified index is larger than the number of items in the game (0x176), the name of item 0 ("????????") is buffered instead.
|
|
.macro bufferitemnameplural out:req, item:req, quantity:req
|
|
.byte 0xe2
|
|
.byte \out
|
|
.2byte \item
|
|
.2byte \quantity
|
|
.endm
|
|
|
|
|
|
@ Supplementary
|
|
|
|
.macro goto_if_unset flag:req, dest:req
|
|
checkflag \flag
|
|
goto_if FALSE, \dest
|
|
.endm
|
|
|
|
.macro goto_if_set flag:req, dest:req
|
|
checkflag \flag
|
|
goto_if TRUE, \dest
|
|
.endm
|
|
|
|
.macro goto_if_lt dest:req @ LESS THAN
|
|
goto_if 0, \dest
|
|
.endm
|
|
|
|
.macro goto_if_eq dest:req @ EQUAL
|
|
goto_if 1, \dest
|
|
.endm
|
|
|
|
.macro goto_if_gt dest:req @ GREATER THAN
|
|
goto_if 2, \dest
|
|
.endm
|
|
|
|
.macro goto_if_le dest:req @ LESS THAN OR EQUAL
|
|
goto_if 3, \dest
|
|
.endm
|
|
|
|
.macro goto_if_ge dest:req @ GREATER THAN OR EQUAL
|
|
goto_if 4, \dest
|
|
.endm
|
|
|
|
.macro goto_if_ne dest:req @ NOT EQUAL
|
|
goto_if 5, \dest
|
|
.endm
|
|
|
|
.macro call_if_unset flag:req, dest:req
|
|
checkflag \flag
|
|
call_if FALSE, \dest
|
|
.endm
|
|
|
|
.macro call_if_set flag:req, dest:req
|
|
checkflag \flag
|
|
call_if TRUE, \dest
|
|
.endm
|
|
|
|
.macro call_if_lt dest:req @ LESS THAN
|
|
call_if 0, \dest
|
|
.endm
|
|
|
|
.macro call_if_eq dest:req @ EQUAL
|
|
call_if 1, \dest
|
|
.endm
|
|
|
|
.macro call_if_gt dest:req @ GREATER THAN
|
|
call_if 2, \dest
|
|
.endm
|
|
|
|
.macro call_if_le dest:req @ LESS THAN OR EQUAL
|
|
call_if 3, \dest
|
|
.endm
|
|
|
|
.macro call_if_ge dest:req @ GREATER THAN OR EQUAL
|
|
call_if 4, \dest
|
|
.endm
|
|
|
|
.macro call_if_ne dest:req @ NOT EQUAL
|
|
call_if 5, \dest
|
|
.endm
|
|
|
|
.macro vgoto_if_eq dest:req
|
|
vgoto_if TRUE, \dest
|
|
.endm
|
|
|
|
.macro vgoto_if_ne dest:req
|
|
vgoto_if FALSE, \dest
|
|
.endm
|
|
|
|
.macro vgoto_if_unset flag:req, dest:req
|
|
checkflag \flag
|
|
vgoto_if FALSE, \dest
|
|
.endm
|
|
|
|
.macro vgoto_if_set flag:req, dest:req
|
|
checkflag \flag
|
|
vgoto_if TRUE, \dest
|
|
.endm
|
|
|
|
.macro goto_if_defeated trainer:req, dest:req
|
|
checktrainerflag \trainer
|
|
goto_if TRUE, \dest
|
|
.endm
|
|
|
|
.macro goto_if_not_defeated trainer:req, dest:req
|
|
checktrainerflag \trainer
|
|
goto_if FALSE, \dest
|
|
.endm
|
|
|
|
.macro call_if_defeated trainer:req, dest:req
|
|
checktrainerflag \trainer
|
|
call_if TRUE, \dest
|
|
.endm
|
|
|
|
.macro call_if_not_defeated trainer:req, dest:req
|
|
checktrainerflag \trainer
|
|
call_if FALSE, \dest
|
|
.endm
|
|
|
|
.macro switch var:req
|
|
copyvar VAR_0x8000, \var
|
|
.endm
|
|
|
|
.macro case condition:req, dest:req
|
|
compare VAR_0x8000, \condition
|
|
goto_if_eq \dest
|
|
.endm
|
|
|
|
@ Message box types
|
|
MSGBOX_NPC = 2
|
|
MSGBOX_SIGN = 3
|
|
MSGBOX_DEFAULT = 4
|
|
MSGBOX_YESNO = 5
|
|
MSGBOX_AUTOCLOSE = 6
|
|
MSGBOX_GETPOINTS = 9
|
|
|
|
YES = 1
|
|
NO = 0
|
|
|
|
.macro msgbox text:req, type=MSGBOX_DEFAULT
|
|
loadword 0, \text
|
|
callstd \type
|
|
.endm
|
|
|
|
.macro giveitem item:req, amount=1
|
|
setorcopyvar VAR_0x8000, \item
|
|
setorcopyvar VAR_0x8001, \amount
|
|
callstd STD_OBTAIN_ITEM
|
|
.endm
|
|
|
|
.macro finditem item:req, amount=1
|
|
setorcopyvar VAR_0x8000, \item
|
|
setorcopyvar VAR_0x8001, \amount
|
|
callstd STD_FIND_ITEM
|
|
.endm
|
|
|
|
.macro givedecoration decoration:req
|
|
setorcopyvar VAR_0x8000, \decoration
|
|
callstd STD_OBTAIN_DECORATION
|
|
.endm
|
|
|
|
.macro register_matchcall trainer:req
|
|
setvar VAR_0x8004, \trainer
|
|
special SetMatchCallRegisteredFlag
|
|
setorcopyvar VAR_0x8000, \trainer
|
|
callstd STD_REGISTER_MATCH_CALL
|
|
.endm
|
|
|
|
.macro dofieldeffectsparkle x:req, y:req, priority:req
|
|
setfieldeffectargument 0, \x
|
|
setfieldeffectargument 1, \y
|
|
setfieldeffectargument 2, \priority
|
|
dofieldeffect FLDEFF_SPARKLE
|
|
.endm
|