diff options
Diffstat (limited to 'docs/text_commands.md')
-rw-r--r-- | docs/text_commands.md | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/docs/text_commands.md b/docs/text_commands.md new file mode 100644 index 000000000..cf3a53327 --- /dev/null +++ b/docs/text_commands.md @@ -0,0 +1,164 @@ +# Text Commands + +Defined in [macros/scripts/text.asm](/macros/scripts/text.asm) and [home/text.asm:TextCommands](/home/text.asm). + + +## `$00`: `text` *text* + +Start writing text until `"@"`. + + +## `$4E`: `next` *text* + +Move a line down. + + +## `$4F`: `line` *text* + +Start writing at the bottom line. + + +## `$50`: `page` *text* + +Start a new Pokédex page. + + +## `$51`: `para` *text* + +Start a new paragraph. + + +## `$55`: `cont` *text* + +Scroll to the next line. + + +## `$57`: `done` + +End a text box. + + +## `$58`: `prompt` + +Prompt the player to end a text box (initiating some other event). + + +## `$01`: `text_from_ram` *address* + +Write text from a RAM address. + + +## `$02`: `text_bcd` *address*, *flags* + +Write [BCD](bcd) from an address, typically RAM. + +[bcd]: https://en.wikipedia.org/wiki/Binary-coded_decimal + + +## `$03`: `text_move` *address* + +Move to a new tile. + + +## `$04`: `text_box` *address*, *height*, *width* + +Draw a box. + + +## `$05`: `text_low` + +Write text at (1, 16). + + +## `$06`: `text_waitbutton` + +Wait for button press; show arrow. + + +## `$07`: `text_scroll` + +Pushes text up two lines and sets the `bc` cursor to the border tile below the +first character column of the text box. + + +## `$08`: `start_asm` + +Start interpreting assembly code. + + +## `$09`: `deciram` *address*, *bytes*, *digits* + +Read *bytes* bytes from *address* and print them as a *digits*-digit number. + + +## `$0A`: `interpret_data` + +Exit. + + +## `$0B`: `sound_dex_fanfare_50_79` + +Play `SFX_DEX_FANFARE_50_79`. + + +## `$0C`: `limited_interpret_data` *number* + +Print *number* `"…"`s. + + +## `$0D`: `link_wait_button` + +Wait for button press; show arrow. + + +## `$0E`: `sound_dex_fanfare_20_49` + +Play `SFX_DEX_FANFARE_20_49`. + + +## `$0F`: `sound_item` + +Play `SFX_ITEM`. + + +## `$10`: `sound_caught_mon` + +Play `SFX_CAUGHT_MON`. + + +## `$11`: `sound_dex_fanfare_80_109` + +Play `SFX_DEX_FANFARE_80_109`. + + +## `$12`: `sound_fanfare` + +Play `SFX_FANFARE`. + + +## `$13`: `sound_slot_machine_start` + +Play `SFX_SLOT_MACHINE_START`. + + +## `$14`: `text_buffer` *id* + +Write text from one of the following addresses (listed in `StringBufferPointers`): + +0. `StringBuffer3` +1. `StringBuffer4` +2. `StringBuffer5` +3. `StringBuffer2` +4. `StringBuffer1` +5. `EnemyMonNick` +6. `BattleMonNick` + + +## `$15`: `current_day` + +Print the weekday. + + +## `$16`: `text_jump` *address* + +Write text from a different bank. |