From 512863989fb2cb17bcca2f27a61fe3fa8f567b9a Mon Sep 17 00:00:00 2001
From: Remy Oukaour <remy.oukaour@gmail.com>
Date: Sat, 9 Dec 2017 00:50:59 -0500
Subject: Document constants with comments, actual names, and more thorough
 usage

---
 constants/script_constants.asm | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'constants/script_constants.asm')

diff --git a/constants/script_constants.asm b/constants/script_constants.asm
index b695c4ee9..9dd4987f8 100644
--- 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
-- 
cgit v1.2.3