summaryrefslogtreecommitdiff
path: root/src/wram.asm
diff options
context:
space:
mode:
authorxCrystal <rgr.crystal@gmail.com>2018-07-10 11:52:24 +0200
committerxCrystal <rgr.crystal@gmail.com>2018-07-10 11:52:24 +0200
commit1ef94a8af1a7232bf6e54911b16e0dd63c4f602f (patch)
tree92e823b0c3a81ea6a24f43fe8b87ed348e2887b0 /src/wram.asm
parent3d15aab87f4d7430037257424ac83ef130198dc7 (diff)
Document some text engine functions
Diffstat (limited to 'src/wram.asm')
-rw-r--r--src/wram.asm30
1 files changed, 22 insertions, 8 deletions
diff --git a/src/wram.asm b/src/wram.asm
index 330a9ed..0691a19 100644
--- a/src/wram.asm
+++ b/src/wram.asm
@@ -1094,10 +1094,17 @@ wce22:: ; ce22
wCardPalette:: ; ce23
ds CGB_PAL_SIZE
-wce2b:: ; ce2b
- ds $1
-
- ds $13
+; information about the text being currently processed, like the font width
+; the rom bank, and the memory address of the next character to be printed.
+; supports up to four nested texts (used with TX_RAM).
+wTextStruct1:: ; ce2b
+ text_struct wTextStruct1
+wTextStruct2:: ; ce30
+ text_struct wTextStruct2
+wTextStruct3:: ; ce35
+ text_struct wTextStruct3
+wTextStruct4:: ; ce3a
+ text_struct wTextStruct4
; text id for the first TX_RAM2 of a text
; prints from wDefaultText if $0000
@@ -1108,23 +1115,30 @@ wTxRam2:: ; cd3f
wTxRam2_b:: ; ce41
ds $2
-; a number between 0 and 65535 for TX_RAM3
+; text id for the first TX_RAM3 of a text
+; a number between 0 and 65535
wTxRam3:: ; ce43
ds $2
+; text id for the second TX_RAM3 of a text
+; a number between 0 and 65535
+wTxRam3_b:: ; ce45
ds $2
; when printing text, number of frames to wait between each text tile
wTextSpeed:: ; ce47
ds $1
-wce48:: ; ce48
+; a number between 0 and 3 to select a wTextStruct to use for the current text
+wWhichTextStruct:: ; ce48
ds $1
-wce49:: ; ce49
+; selects wTxRam2 or wTxRam2_b
+wWhichTxRam2:: ; ce49
ds $1
-wce4a:: ; ce4a
+; selects wTxRam3 or wTxRam3_b
+wWhichTxRam3:: ; ce4a
ds $1
wIsTextBoxLabeled:: ; ce4b