Identify more sprite-related constants

Start more documentation
2017-12-12 13:22:19 -05:00
parent c5675927fe
commit 5b13a7a13b
20 changed files with 713 additions and 522 deletions
--- a/macros/event.asm
+++ b/macros/event.asm
@@ -1,3 +1,4 @@
+; ScriptCommandTable indexes (see engine/scripting.asm)
 	enum_start

 	enum scall_command
--- a/macros/move_anim.asm
+++ b/macros/move_anim.asm
@@ -5,6 +5,7 @@ endc
 	db \1
 	endm

+; BattleAnimCommands indexes (see battle/anim_commands.asm)
 	enum_start $d0

 	enum anim_obj_command ; d0
--- a/macros/movement.asm
+++ b/macros/movement.asm
@@ -1,3 +1,4 @@
+; MovementPointers indexes (see engine/movement.asm)
 	enum_start

 ; Directional movements
--- a/macros/sound.asm
+++ b/macros/sound.asm
@@ -23,7 +23,9 @@ cry_header: macro
 	dw \1, \2, \3
 	endm

+; MusicCommands indexes (see audio/engine.asm)
 	enum_start $d8
+
 	enum notetype_cmd
 octave: macro
 	db notetype_cmd - (\1)
--- a/macros/text.asm
+++ b/macros/text.asm
@@ -7,9 +7,9 @@ cont   EQUS "db $55," ; Scroll to the next line.
 done   EQUS "db $57"  ; End a text box.
 prompt EQUS "db $58"  ; Prompt the player to end a text box (initiating some other event).

-; TX_RAM EQU $01
-; TX_FAR EQU $16
-	enum_start 1
+; TextCommands indexes (see home/text.asm)
+	enum_start $01
+
 	enum TX_RAM
 text_from_ram: MACRO
 	db TX_RAM
--- a/macros/trade_anim.asm
+++ b/macros/trade_anim.asm
@@ -1,4 +1,6 @@
+; DoTradeAnimation.JumpTable indexes (see engine/trade/animation.asm)
 	enum_start
+
 	enum tradeanim_next_command
 tradeanim_next: macro
 	db tradeanim_next_command ; 00