summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRemy Oukaour <remy.oukaour@gmail.com>2017-12-23 01:19:34 -0500
committerRemy Oukaour <remy.oukaour@gmail.com>2017-12-23 01:19:34 -0500
commit2f9f2317a3e02808a20449e8b9ed55d0718e5f0b (patch)
tree6374408d62f9cb5f658f74e42f81b7b0b3e26388
parentaa97752efeef1425a0e0a00059f4a44569c917fc (diff)
Document the meaning of hour and daytime values for person_events
-rw-r--r--macros/scripts/maps.asm8
-rw-r--r--maps/second_map_headers.asm2
2 files changed, 7 insertions, 3 deletions
diff --git a/macros/scripts/maps.asm b/macros/scripts/maps.asm
index 010506544..6c1e0b6b6 100644
--- a/macros/scripts/maps.asm
+++ b/macros/scripts/maps.asm
@@ -43,8 +43,12 @@ person_event: macro
;\3: x: left to right, starts at 0
;\4: movement function: a SPRITEMOVEDATA_* constant
;\5, \6: movement radius: y, x
-;\7: clock hour: ???
-;\8: clock daytime: sum of MORN, DAY, and/or NITE, or 0 for always
+;\7, \8: hour1 and hour2: control the hours a person_event is visible (0-23)
+; * if hour1 < hour2, the person_event will only appear from hour1 to hour2
+; * if hour1 > hour2, the person_event will not appear from hour2 to hour1
+; * if hour1 == hour2, the person_event will always appear
+; * if hour1 == -1, hour2 is treated as a time-of-day value:
+; a combo of MORN, DAY, and/or NITE, or -1 to always appear
;\9: color: a PAL_NPC_* constant, or 0 for sprite default
;\10: function: a PERSONTYPE_* constant
;\11: sight range: applies to PERSONTYPE_TRAINER
diff --git a/maps/second_map_headers.asm b/maps/second_map_headers.asm
index f4162226f..e81c8c774 100644
--- a/maps/second_map_headers.asm
+++ b/maps/second_map_headers.asm
@@ -2,7 +2,7 @@ map_header_2: macro
;\1: map label
;\2: map id
;\3: border block
-;\4: connections: sum of NORTH, SOUTH, WEST, and/or EAST, or 0 for none
+;\4: connections: combo of NORTH, SOUTH, WEST, and/or EAST, or 0 for none
\1_SecondMapHeader::
db \3
db \2_HEIGHT, \2_WIDTH