diff options
Diffstat (limited to 'docs/text_commands.md')
-rw-r--r-- | docs/text_commands.md | 106 |
1 files changed, 58 insertions, 48 deletions
diff --git a/docs/text_commands.md b/docs/text_commands.md index df9af1908..36a470cb8 100644 --- a/docs/text_commands.md +++ b/docs/text_commands.md @@ -3,47 +3,12 @@ Defined in [macros/scripts/text.asm](/macros/scripts/text.asm) and [home/text.asm:TextCommands](/home/text.asm). -## `$00`: <code>text <i>text</i></code> - -Start writing text until `"@"`. - - -## `$4E`: <code>next <i>text</i></code> - -Move a line down. - - -## `$4F`: <code>line <i>text</i></code> - -Start writing at the bottom line. - - -## `$50`: <code>page <i>text</i></code> - -Start a new Pokédex page. - - -## `$51`: <code>para <i>text</i></code> - -Start a new paragraph. - - -## `$55`: <code>cont <i>text</i></code> - -Scroll to the next line. - - -## `$57`: `done` - -End a text box. - - -## `$58`: `prompt` +## `$00`: `text_start` -Prompt the player to end a text box (initiating some other event). +Start writing text until `"@"`. The text can use [control characters](#control-characters). -## `$01`: <code>text_from_ram <i>address</i></code> +## `$01`: <code>text_ram <i>address</i></code> Write text from a RAM address. @@ -81,19 +46,19 @@ 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` +## `$08`: `text_asm` Start interpreting assembly code. -## `$09`: <code>deciram <i>address</i>, <i>bytes</i>, <i>digits</i></code> +## `$09`: <code>text_decimal <i>address</i>, <i>bytes</i>, <i>digits</i></code> Read *bytes* bytes from *address* and print them as a *digits*-digit number. -## `$0A`: `interpret_data` +## `$0A`: `text_pause` -Exit. +Pause for 30 frames unless A or B is pressed. ## `$0B`: `sound_dex_fanfare_50_79` @@ -101,12 +66,12 @@ Exit. Play `SFX_DEX_FANFARE_50_79`. -## `$0C`: <code>limited_interpret_data <i>n</i></code> +## `$0C`: <code>text_dots <i>n</i></code> -Print *n* `"…"`s. +Print *n* `"…"`s, pausing for 10 frames after each; interrupt if A or B is pressed. -## `$0D`: `link_wait_button` +## `$0D`: `text_linkwaitbutton` Wait for button press; show arrow. @@ -154,7 +119,7 @@ Write text from one of the following addresses (listed in [data/text_buffers.asm 6. `BattleMonNick` -## `$15`: `current_day` +## `$15`: `text_today` Print the weekday. @@ -164,6 +129,51 @@ Print the weekday. Write text from a different bank. -## `$00`: `text_start` +## `$50`: `text_end` + +Stops processing text commands. + -Start writing regular text again after a special command. +# Control characters + +These get interpreted in the context of printing regular text. Macros exist to conveniently place the control characters. + + +## `$00`: <code>text <i>text</i></code> + +Start writing text until `"@"`. (Not actually a control character, but shorter than `text_start` followed by `db`.) + + +## `$4E`, `"<NEXT>"`: <code>next <i>text</i></code> + +Move a line down. + + +## `$4F`, `"<LINE>"`: <code>line <i>text</i></code> + +Start writing at the bottom line. + + +## `$50`, `"@"`: <code>page <i>text</i></code> + +Start a new Pokédex page. + + +## `$51`, `"<PARA>"`: <code>para <i>text</i></code> + +Start a new paragraph. + + +## `$55`, `"<CONT>"`: <code>cont <i>text</i></code> + +Scroll to the next line. + + +## `$57`, `"<DONE>"`: `done` + +End a text box. + + +## `$58`, `"<PROMPT>"`: `prompt` + +Prompt the player to end a text box (initiating some other event). |