Document better Aurora Event Framework

1 files changed, 13 insertions, 0 deletions

diff --git a/npc/functions/aurora.txt b/npc/functions/aurora.txt
index 24e0698a2..3095b333b 100644
--- a/npc/functions/aurora.txt
+++ b/npc/functions/aurora.txt
@@ -11,6 +11,19 @@
 //    Aurora Event Framework functions are called by event.txt
 //    specs override and is overriden by those defined in commands/event.txt
 
+// Variables:
+//      $MOST_HEROIC$
+//          Updated every 2 weeks, the top 1 from previous event
+//          Only the hero may begin sieges against Fortress Town.
+//          Every NPC will recognize them, and Lightbringer will also
+//          pay special attention to them.
+//      $FYEVENT_CYCLE
+//          Current cycle. I thought in using gettimeparam(WEEK) but gave up.
+//      $@REGNUM_BLESSMAP$
+//          Map under Regnum's Blessing
+//      $@REGNUM_BLESSMAP_H$
+//          Human-readable form of the map under Regnum's Blessing
+
 // AEF: BEGIN
 function	script	FYNewEvent	{
     debugmes "\033[1mFY event is set to happen...";