ref: ffa63c51df4d954e5fd9af99f376e1a4837b9dad
parent: 1fc7430a2baa2835f4dad4676a3e7ae513275a7d
author: mid-kid <esteve.varela@gmail.com>
date: Tue Jul 17 19:11:17 EDT 2018
Clean up TX_ commands Some of the TX_ commands didn't use the TX_ prefix for their constants, and the label names were inconsistent. I've chosen to adopt the `TextCommand_` prefix as opposed to `Text_`, as it has a clear difference in namespace compared to the possibly-used `Text_` namespace for actual dialogue text.
--- a/home/text.asm
+++ b/home/text.asm
@@ -682,32 +682,32 @@
TextCommands::
; entries correspond to TX_* constants (see macros/scripts/text.asm)
- dw Text_TX ; TX_START
- dw Text_TX_RAM ; TX_RAM
- dw Text_TX_BCD ; TX_BCD
- dw Text_TX_MOVE ; TX_MOVE
- dw Text_TX_BOX ; TX_BOX
- dw Text_TX_LOW ; TX_LOW
- dw Text_WAIT_BUTTON ; WAIT_BUTTON
- dw Text_TX_SCROLL ; TX_SCROLL
- dw Text_START_ASM ; START_ASM
- dw Text_TX_NUM ; TX_NUM
- dw Text_TX_EXIT ; TX_EXIT
- dw Text_PlaySound ; TX_SOUND_DEX_FANFARE_50_79
- dw Text_TX_DOTS ; TX_DOTS
- dw Text_LINK_WAIT_BUTTON ; TX_LINK_WAIT_BUTTON
- dw Text_PlaySound ; TX_SOUND_DEX_FANFARE_20_49
- dw Text_PlaySound ; TX_SOUND_ITEM
- dw Text_PlaySound ; TX_SOUND_CAUGHT_MON
- dw Text_PlaySound ; TX_SOUND_DEX_FANFARE_80_109
- dw Text_PlaySound ; TX_SOUND_FANFARE
- dw Text_PlaySound ; TX_SOUND_SLOT_MACHINE_START
- dw Text_TX_STRINGBUFFER ; TX_STRINGBUFFER
- dw Text_TX_DAY ; TX_DAY
- dw Text_TX_FAR ; TX_FAR
+ dw TextCommand_START ; TX_START
+ dw TextCommand_RAM ; TX_RAM
+ dw TextCommand_BCD ; TX_BCD
+ dw TextCommand_MOVE ; TX_MOVE
+ dw TextCommand_BOX ; TX_BOX
+ dw TextCommand_LOW ; TX_LOW
+ dw TextCommand_WAIT_BUTTON ; TX_WAIT_BUTTON
+ dw TextCommand_SCROLL ; TX_SCROLL
+ dw TextCommand_START_ASM ; TX_START_ASM
+ dw TextCommand_NUM ; TX_NUM
+ dw TextCommand_EXIT ; TX_EXIT
+ dw TextCommand_SOUND ; TX_SOUND_DEX_FANFARE_50_79
+ dw TextCommand_DOTS ; TX_DOTS
+ dw TextCommand_LINK_WAIT_BUTTON ; TX_LINK_WAIT_BUTTON
+ dw TextCommand_SOUND ; TX_SOUND_DEX_FANFARE_20_49
+ dw TextCommand_SOUND ; TX_SOUND_ITEM
+ dw TextCommand_SOUND ; TX_SOUND_CAUGHT_MON
+ dw TextCommand_SOUND ; TX_SOUND_DEX_FANFARE_80_109
+ dw TextCommand_SOUND ; TX_SOUND_FANFARE
+ dw TextCommand_SOUND ; TX_SOUND_SLOT_MACHINE_START
+ dw TextCommand_STRINGBUFFER ; TX_STRINGBUFFER
+ dw TextCommand_DAY ; TX_DAY
+ dw TextCommand_FAR ; TX_FAR
-Text_TX::
-; TX
+TextCommand_START::
+; text_start
; write text until "@"
; [$00]["...@"]
@@ -721,7 +721,7 @@
inc hl
ret
-Text_TX_RAM::
+TextCommand_RAM::
; text_from_ram
; write text from a ram address
; little endian
@@ -738,7 +738,7 @@
pop hl
ret
-Text_TX_FAR::
+TextCommand_FAR::
; text_jump
; write text from a different bank
; little endian
@@ -767,8 +767,8 @@
ld [MBC3RomBank], a
ret
-Text_TX_BCD::
-; TX_BCD
+TextCommand_BCD::
+; text_bcd
; write bcd from address, typically ram
; [$02][addr][flags]
; flags: see PrintBCDNumber
@@ -788,8 +788,8 @@
pop hl
ret
-Text_TX_MOVE::
-; TX_MOVE
+TextCommand_MOVE::
+; text_move
; move to a new tile
; [$03][addr]
@@ -801,8 +801,8 @@
ld b, a
ret
-Text_TX_BOX::
-; TX_BOX
+TextCommand_BOX::
+; text_box
; draw a box
; little endian
; [$04][addr][height][width]
@@ -822,8 +822,8 @@
pop hl
ret
-Text_TX_LOW::
-; TX_LOW
+TextCommand_LOW::
+; text_low
; write text at (1,16)
; [$05]
@@ -830,8 +830,8 @@
bccoord TEXTBOX_INNERX, TEXTBOX_INNERY + 2
ret
-Text_WAIT_BUTTON::
-; TX_WAITBUTTON
+TextCommand_WAIT_BUTTON::
+; text_waitbutton
; wait for button press
; show arrow
; [06]
@@ -838,9 +838,9 @@
ld a, [wLinkMode]
cp LINK_COLOSSEUM
- jp z, Text_LINK_WAIT_BUTTON
+ jp z, TextCommand_LINK_WAIT_BUTTON
cp LINK_MOBILE
- jp z, Text_LINK_WAIT_BUTTON
+ jp z, TextCommand_LINK_WAIT_BUTTON
push hl
call LoadBlinkingCursor
@@ -851,7 +851,8 @@
pop hl
ret
-Text_TX_SCROLL::
+TextCommand_SCROLL::
+; 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.
push hl
@@ -862,8 +863,8 @@
bccoord TEXTBOX_INNERX, TEXTBOX_INNERY + 2
ret
-Text_START_ASM::
-; TX_ASM
+TextCommand_START_ASM::
+; start_asm
bit 7, h
jr nz, .not_rom
@@ -874,8 +875,8 @@
ld [hl], a
ret
-Text_TX_NUM::
-; TX_NUM
+TextCommand_NUM::
+; deciram
; [$09][addr][hi:bytes lo:digits]
ld a, [hli]
ld e, a
@@ -899,7 +900,8 @@
pop hl
ret
-Text_TX_EXIT::
+TextCommand_EXIT::
+; interpret_data
push hl
push bc
call GetJoypad
@@ -913,7 +915,7 @@
pop hl
ret
-Text_PlaySound::
+TextCommand_SOUND::
; chars:
; $0b, $0e, $0f, $10, $11, $12, $13
; see TextSFX
@@ -949,7 +951,7 @@
ret
Unreferenced_Function1522::
-; TX_CRY
+; play_cry
push de
ld e, [hl]
inc hl
@@ -970,7 +972,8 @@
dbw TX_SOUND_SLOT_MACHINE_START, SFX_SLOT_MACHINE_START
db -1
-Text_TX_DOTS::
+TextCommand_DOTS::
+; limited_interpret_data
; [$0C][num]
ld a, [hli]
ld d, a
@@ -998,7 +1001,8 @@
pop hl
ret
-Text_LINK_WAIT_BUTTON::
+TextCommand_LINK_WAIT_BUTTON::
+; link_wait_button
; wait for key down
; display arrow
push hl
@@ -1008,7 +1012,8 @@
pop hl
ret
-Text_TX_STRINGBUFFER::
+TextCommand_STRINGBUFFER::
+; text_buffer
; Print a string from one of the following:
; 0: wStringBuffer3
; 1: wStringBuffer4
@@ -1036,8 +1041,8 @@
pop hl
ret
-Text_TX_DAY::
-; TX_DAY
+TextCommand_DAY::
+; current_day
call GetWeekday
push hl
--- a/macros/scripts/text.asm
+++ b/macros/scripts/text.asm
@@ -46,9 +46,9 @@
db TX_LOW
ENDM
- enum WAIT_BUTTON ; $06
+ enum TX_WAIT_BUTTON ; $06
text_waitbutton: MACRO
- db WAIT_BUTTON
+ db TX_WAIT_BUTTON
ENDM
enum TX_SCROLL ; $07
@@ -56,9 +56,9 @@
db TX_SCROLL
ENDM
- enum START_ASM ; $08
+ enum TX_START_ASM ; $08
start_asm: MACRO
- db START_ASM
+ db TX_START_ASM
ENDM
enum TX_NUM ; $09