Document constants with comments, actual names, and more thorough usage

2017-12-09 00:50:59 -05:00
parent 89b9292db0
commit 512863989f
86 changed files with 2222 additions and 1980 deletions
--- a/constants/script_constants.asm
+++ b/constants/script_constants.asm
@@ -2,6 +2,7 @@
 PLAYER      EQU  0
 LAST_TALKED EQU -2

+; GetVarAction arguments (see engine/variables.asm)
 	const_def
 	const VAR_STRINGBUFFER2    ; 00
 	const VAR_PARTYCOUNT       ; 01
@@ -32,10 +33,12 @@ LAST_TALKED EQU -2
 	const VAR_KENJI_BREAK      ; 1a
 NUM_VARS EQU const_value       ; 1b

+; variable action types
 RETVAR_STRBUF2 EQU (0 << 6)
 RETVAR_ADDR_DE EQU (1 << 6)
 RETVAR_EXECUTE EQU (2 << 6)

+; PlayerEventScriptPointers indexes (see engine/events.asm)
 const_value SET -1
 	const PLAYEREVENT_MAPSCRIPT
 	const PLAYEREVENT_NONE