pokecrystal/macros/scripts/text.asm

text   EQUS "db TX_START,"    ; Start writing text.
next   EQUS "db \"<NEXT>\","  ; Move a line down.
line   EQUS "db \"<LINE>\","  ; Start writing at the bottom line.
page   EQUS "db \"@\","       ; Start a new Pokédex page.
para   EQUS "db \"<PARA>\","  ; Start a new paragraph.
cont   EQUS "db \"<CONT>\","  ; Scroll to the next line.
done   EQUS "db \"<DONE>\""   ; End a text box.
prompt EQUS "db \"<PROMPT>\"" ; Prompt the player to end a text box (initiating some other event).

; TextCommands indexes (see home/text.asm)
	const_def

	const TX_START ; $00
text_start: MACRO
	db TX_START
ENDM

	const TX_RAM ; $01
text_ram: MACRO
	db TX_RAM
	dw \1
ENDM

	const TX_BCD ; $02
text_bcd: MACRO
	db TX_BCD
	dw \1
	db \2
ENDM

	const TX_MOVE ; $03
text_move: MACRO
	db TX_MOVE
	dw \1
ENDM

	const TX_BOX ; $04
text_box: MACRO
	db TX_BOX
	dw \1
	db \2, \3
ENDM

	const TX_LOW ; $05
text_low: MACRO
	db TX_LOW
ENDM

	const TX_PROMPT_BUTTON ; $06
text_promptbutton: MACRO
	db TX_PROMPT_BUTTON
ENDM

	const TX_SCROLL ; $07
text_scroll: MACRO
	db TX_SCROLL
ENDM

	const TX_START_ASM ; $08
text_asm: MACRO
	db TX_START_ASM
ENDM

	const TX_DECIMAL ; $09
text_decimal: MACRO
	db TX_DECIMAL
	dw \1 ; address
	dn \2, \3 ; bytes, digits
ENDM

	const TX_PAUSE ; $0a
text_pause: MACRO
	db TX_PAUSE
ENDM

	const TX_SOUND_DEX_FANFARE_50_79 ; $0b
sound_dex_fanfare_50_79: MACRO
	db TX_SOUND_DEX_FANFARE_50_79
ENDM

	const TX_DOTS ; $0c
text_dots: MACRO
	db TX_DOTS
	db \1
ENDM

	const TX_WAIT_BUTTON ; $0d
text_waitbutton: MACRO
	db TX_WAIT_BUTTON
ENDM

	const TX_SOUND_DEX_FANFARE_20_49 ; $0e
sound_dex_fanfare_20_49: MACRO
	db TX_SOUND_DEX_FANFARE_20_49
ENDM

	const TX_SOUND_ITEM ; $0f
sound_item: MACRO
	db TX_SOUND_ITEM
ENDM

	const TX_SOUND_CAUGHT_MON ; $10
sound_caught_mon: MACRO
	db TX_SOUND_CAUGHT_MON
ENDM

	const TX_SOUND_DEX_FANFARE_80_109 ; $11
sound_dex_fanfare_80_109: MACRO
	db TX_SOUND_DEX_FANFARE_80_109
ENDM

	const TX_SOUND_FANFARE ; $12
sound_fanfare: MACRO
	db TX_SOUND_FANFARE
ENDM

	const TX_SOUND_SLOT_MACHINE_START ; $13
sound_slot_machine_start: MACRO
	db TX_SOUND_SLOT_MACHINE_START
ENDM

	const TX_STRINGBUFFER ; $14
text_buffer: MACRO
	db TX_STRINGBUFFER
	db \1
ENDM

	const TX_DAY ; $15
text_today: MACRO
	db TX_DAY
ENDM

	const TX_FAR ; $16
text_far: MACRO
	db TX_FAR
	dw \1
	db BANK(\1)
ENDM

NUM_TEXT_CMDS EQU const_value

	const_next $50

	const TX_END ; $50
text_end: MACRO
	db TX_END
ENDM
More charmap and home/text.asm documentation for JP chars 2018-01-18 23:34:20 +00:00			`text EQUS "db TX_START," ; Start writing text.`
More comments for macros 2017-12-15 05:38:52 +00:00			`next EQUS "db \"<NEXT>\"," ; Move a line down.`
			`line EQUS "db \"<LINE>\"," ; Start writing at the bottom line.`
			`page EQUS "db \"@\"," ; Start a new Pokédex page.`
			`para EQUS "db \"<PARA>\"," ; Start a new paragraph.`
			`cont EQUS "db \"<CONT>\"," ; Scroll to the next line.`
			`done EQUS "db \"<DONE>\"" ; End a text box.`
			`prompt EQUS "db \"<PROMPT>\"" ; Prompt the player to end a text box (initiating some other event).`
Start moving relevant macros into macros/text.asm. 2015-01-20 22:10:55 +00:00
Identify more sprite-related constants Start more documentation 2017-12-12 18:22:19 +00:00			`; TextCommands indexes (see home/text.asm)`
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const_def`
More charmap and home/text.asm documentation for JP chars 2018-01-18 23:34:20 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_START ; $00`
More charmap and home/text.asm documentation for JP chars 2018-01-18 23:34:20 +00:00			`text_start: MACRO`
			`db TX_START`
			`ENDM`
Identify more sprite-related constants Start more documentation 2017-12-12 18:22:19 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_RAM ; $01`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_ram: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_RAM`
			`dw \1`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Local labels starting with capital letters are now decorated with a trailing colon; remove trailing whitespace; globally correct line endings to UNIX style 2016-04-10 18:42:14 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_BCD ; $02`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`text_bcd: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_BCD`
			`dw \1`
			`db \2`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Start moving relevant macros into macros/text.asm. 2015-01-20 22:10:55 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_MOVE ; $03`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`text_move: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_MOVE`
Start moving relevant macros into macros/text.asm. 2015-01-20 22:10:55 +00:00			`dw \1`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Start moving relevant macros into macros/text.asm. 2015-01-20 22:10:55 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_BOX ; $04`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`text_box: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_BOX`
Various annotations Annotated the SGB functions in predef/sgb.asm, and some of the map scripts. Renamed several functions in home. Renamed six WRAM addresses corresponding to party icon animations, and renamed several others relative to these. 2015-07-22 19:57:02 +00:00			`dw \1`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db \2, \3`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_LOW ; $05`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`text_low: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_LOW`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_PROMPT_BUTTON ; $06`
Rename buttonsound to promptbutton 2019-11-03 17:48:54 +00:00			`text_promptbutton: MACRO`
			`db TX_PROMPT_BUTTON`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SCROLL ; $07`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`text_scroll: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_SCROLL`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_START_ASM ; $08`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_asm: MACRO`
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. 2018-07-17 21:11:17 +00:00			`db TX_START_ASM`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
TX_NUM -> TX_DECIMAL 2020-08-03 20:56:33 +00:00			`const TX_DECIMAL ; $09`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_decimal: MACRO`
TX_NUM -> TX_DECIMAL 2020-08-03 20:56:33 +00:00			`db TX_DECIMAL`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`dw \1 ; address`
			`dn \2, \3 ; bytes, digits`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_PAUSE ; $0a`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_pause: MACRO`
			`db TX_PAUSE`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_DEX_FANFARE_50_79 ; $0b`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_dex_fanfare_50_79: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_DEX_FANFARE_50_79`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_DOTS ; $0c`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_dots: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_DOTS`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00			`db \1`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_WAIT_BUTTON ; $0d`
text_linkpromptbutton -> text_waitbutton Removes support for text_waitbutton as a legacy alias for text_promptbutton. 2020-07-06 16:55:31 +00:00			`text_waitbutton: MACRO`
			`db TX_WAIT_BUTTON`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Enumerate text constants 2015-10-30 14:34:35 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_DEX_FANFARE_20_49 ; $0e`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_dex_fanfare_20_49: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_DEX_FANFARE_20_49`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Enumerate text constants 2015-10-30 14:34:35 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_ITEM ; $0f`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_item: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_ITEM`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_CAUGHT_MON ; $10`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_caught_mon: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_CAUGHT_MON`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_DEX_FANFARE_80_109 ; $11`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_dex_fanfare_80_109: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_DEX_FANFARE_80_109`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_FANFARE ; $12`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_fanfare: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_FANFARE`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Enumerate text constants 2015-10-30 14:34:35 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_SOUND_SLOT_MACHINE_START ; $13`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`sound_slot_machine_start: MACRO`
Better TX_SOUND_* names 2018-01-19 03:06:51 +00:00			`db TX_SOUND_SLOT_MACHINE_START`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_STRINGBUFFER ; $14`
Uppercase MACRO and EQU(S) according to the style guide 2017-12-28 12:23:44 +00:00			`text_buffer: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_STRINGBUFFER`
			`db \1`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Enumerate text constants 2015-10-30 14:34:35 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_DAY ; $15`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_today: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_DAY`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Stop using the preprocessor. 2015-01-20 08:01:23 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_FAR ; $16`
text_jump → text_far The previous name for this was rather misleading. It isn't an actual jump like you'd expect the `jp` instruction to behave as. Instead, it behaves more like a `farcall`. This also makes it consistent with its current command ID name of `TX_FAR`. 2018-10-28 16:16:55 +00:00			`text_far: MACRO`
Enumerate text constants 2015-10-30 14:34:35 +00:00			`db TX_FAR`
			`dw \1`
			`db BANK(\1)`
endm -> ENDM 2017-12-28 21:31:16 +00:00			`ENDM`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00
Verify script command table sizes 2021-03-11 21:28:52 +00:00			`NUM_TEXT_CMDS EQU const_value`

Use const_skip and const_next macros for brevity 2020-07-08 20:20:15 +00:00			`const_next $50`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00
Eliminate enum: use const instead, with case-by-case parallel const implementations 2020-07-08 19:30:23 +00:00			`const TX_END ; $50`
Resolve issue #575: Rename text commands 2018-11-17 18:33:03 +00:00			`text_end: MACRO`
			`db TX_END`
			`ENDM`