Merge pull request #152 from wushin/quest-log-variable-clean-up

Quest log variable clean up

2 files changed, 154 insertions, 217 deletions

diff --git a/world/map/db/const-quest.txt b/world/map/db/const-quest.txt
new file mode 100644
index 00000000..76407b2a
--- /dev/null
+++ b/world/map/db/const-quest.txt
@@ -0,0 +1,154 @@
+// Variables related to quests
+TWOBIT_0_SHIFT 0
+TWOBIT_0_MASK 3
+
+TWOBIT_1_SHIFT 2
+TWOBIT_1_MASK 12
+
+TWOBIT_2_SHIFT 4
+TWOBIT_2_MASK 48
+
+TWOBIT_3_SHIFT 6
+TWOBIT_3_MASK 192
+
+TWOBIT_4_SHIFT 8
+TWOBIT_4_MASK 768
+
+TWOBIT_5_SHIFT 10
+TWOBIT_5_MASK 3072
+
+TWOBIT_6_SHIFT 12
+TWOBIT_6_MASK 12288
+
+TWOBIT_7_SHIFT 14
+TWOBIT_7_MASK 49152
+
+TWOBIT_8_SHIFT 16
+TWOBIT_8_MASK 196608
+
+TWOBIT_9_SHIFT 18
+TWOBIT_9_MASK 786432
+
+TWOBIT_10_SHIFT 20
+TWOBIT_10_MASK 3145728
+
+TWOBIT_11_SHIFT 22
+TWOBIT_11_MASK 12582912
+
+TWOBIT_12_SHIFT 24
+TWOBIT_12_MASK 50331648
+
+TWOBIT_13_SHIFT 26
+TWOBIT_13_MASK 201326592
+
+TWOBIT_14_SHIFT 28
+TWOBIT_14_MASK 805306368
+
+// Not enough space in CONST to store
+//TWOBIT_15_SHIFT 30
+//TWOBIT_15_MASK 3221225472
+
+NIBBLE_0_SHIFT 0
+NIBBLE_0_MASK 15
+
+NIBBLE_1_SHIFT 4
+NIBBLE_1_MASK 240
+
+NIBBLE_2_SHIFT 8
+NIBBLE_2_MASK 3840
+
+NIBBLE_3_SHIFT 12
+NIBBLE_3_MASK 61440
+
+NIBBLE_4_SHIFT 16
+NIBBLE_4_MASK 983040
+
+NIBBLE_5_SHIFT 20
+NIBBLE_5_MASK 15728640
+
+NIBBLE_6_SHIFT 24
+NIBBLE_6_MASK 251658240
+
+NIBBLE_7_SHIFT 28        // Only three bits available in this one
+NIBBLE_7_MASK 1879048192 // should be 4026531840
+
+BYTE_0_SHIFT 0
+BYTE_0_MASK  255
+
+BYTE_1_SHIFT 8
+BYTE_1_MASK  65280
+
+BYTE_2_SHIFT 16
+BYTE_2_MASK  16711680
+
+BYTE_3_SHIFT 24         // only 7 bits in this one
+BYTE_3_MASK  2130706432 // should be 4278190080
+
+// Wedding Variables
+WEDDING_FEE           100
+DIVORCE_FEE_PER_LEVEL 500
+WEDDING_MIN_LEVEL     32
+
+// Flags for the magic quests.
+MFLAG_DRANK_POTION         1     // Character drank at least one magic potion as prerequisite for the Mana Seed quest.
+MFLAG_KNOWS_MANASEED       2     // Character has found the Mana Seed.
+MFLAG_TOUCHED_MANASEED     4     // Character has touched the Mana Seed.
+MFLAG_MANASEED_MAXEDOUT    8     // Character has touched the Mana Seed while maxed out on magic.
+
+MFLAG_KNOWS_AULDSBEL       16    // Character has met Auldsbel.
+MFLAG_KNOWS_WYARA          32    // Character has met Wyara.
+MFLAG_KNOWS_SAGATHA        64    // Character has met Sagatha.
+MFLAG_KNOWS_MANAPOTION     128   // Has heard about the Mana Potion.
+
+MFLAG_MANASEED_RUMOUR      256   // Has heard rumour about Mana Seed.
+MFLAG_KNOWS_CUTTREE        512   // Knows about the 'cut the tree' quest.
+MFLAG_DID_CUTTREE          1024  // Did cut off a branch from the druid tree.
+MFLAG_KNOWS_DRUIDTREE      2048  // Knows about the druid tree quest.
+
+MFLAG_KNOWS_IMP            4096  // Knows about the imprisoned forest spirit.
+MFLAG_KNOWS_OLD_WIZARD     8192  // Knows Bjorn's old wizard.
+MFLAG_MADE_CONC_POTION     16384 // Made a concentration potion with T15 and/or T16.
+MFLAG_ELANORE_OMAR         32768 // Told Omar about Elanore's involvement.
+
+MFLAG_KNOWS_UNFOCUS_RECIPE 65536 // Has been told about unfocus by Luca.
+
+// Flags set in the FLAGS variable:
+FLAG_HAS_BOWLER_BURNSDAY 1    // every year's poem at burns day, shannon gives you a bowler hat
+FLAG_OPENED_UNDERGROUND  2    // this flag is a replacement for variable Open_Underground_Palace_Barrier, which was used only as bool
+FLAG_GOT_NAEM_GLOVES     4    // this replaces Naem_Quest_Done, which was used as a bool variable
+FLAG_GOT_GRADUATIONCAP   8    // this is a bit which was to be found in Tut_var second bit
+FLAG_TOWEL_HELPED        16   // gave the towel npc the stuff he wants
+FLAG_TOWEL_COMPLETED     32   // got the towel from the towel npc
+FLAG_ANDRA_HELPED        64   // Knows Andra and agreed to help her
+FLAG_ROSSI_COMPLETED     128  // Completed the Rossi Quest
+FLAG_TUTORIAL_DONE       256  // player completed tutorial (or entered the tutorial area from outside after it was added)
+FLAG_SNOWMAN             512  // player gave candy to the snowman
+FLAG_SANTAS_HELPER       1024 // player gave presents to Santa's helper
+FLAG_HURNSMINE_CHEST     2048 // player opened the chest with the short sword in Hurnscald mines
+FLAG_GOT_BEANIEHAT       4096 // player got Beanie Copter Hat from Milly
+FLAG_DECLINED_BEANIEHAT  8192 // player declined Beanie Copter Hat from Milly
+
+// Flags for the battle caves.
+BATTLE_CAVE1 1
+BATTLE_CAVE2 2
+BATTLE_CAVE3 4
+BATTLE_CAVE4 8
+BATTLE_CAVE5 16
+BATTLE_CAVE6 32
+BATTLE_CAVE7 64
+BATTLE_CAVE8 128
+BATTLE_CAVE9 256
+
+// Storage Options
+OPT_STORAGE_CLOSE 1
+OPT_BANK_CLOSE 2
+
+// Currently used by the fluffy hunt (033-1).
+// starts counting with 0
+MAX_HIGH_SCORES 4
+
+// Launcher/Ammo Types
+AMMO_NONE  0
+AMMO_BOW   1
+AMMO_SLING 2
+AMMO_WAND  3
diff --git a/world/map/db/const.txt b/world/map/db/const.txt
index 5c8d4ffa..52752c1d 100644
--- a/world/map/db/const.txt
+++ b/world/map/db/const.txt
@@ -304,11 +304,6 @@ EMOTE_CURIOUS    40
 EMOTE_PAIN       41
 EMOTE_TEARS      42
 
-// Wedding Variables
-WEDDING_FEE           100
-DIVORCE_FEE_PER_LEVEL 500
-WEDDING_MIN_LEVEL     32
-
 sfx_skillup         1
 sfx_magic_generic   2
 sfx_magic_life      3
@@ -409,42 +404,6 @@ FX_EMOTE_CURIOUS     10039
 FX_EMOTE_PAIN        10040
 FX_EMOTE_TEARS       10041
 
-NIBBLE_0_SHIFT 0
-NIBBLE_0_MASK 15
-
-NIBBLE_1_SHIFT 4
-NIBBLE_1_MASK 240
-
-NIBBLE_2_SHIFT 8
-NIBBLE_2_MASK 3840
-
-NIBBLE_3_SHIFT 12
-NIBBLE_3_MASK 61440
-
-NIBBLE_4_SHIFT 16
-NIBBLE_4_MASK 983040
-
-NIBBLE_5_SHIFT 20
-NIBBLE_5_MASK 15728640
-
-NIBBLE_6_SHIFT 24
-NIBBLE_6_MASK 251658240
-
-NIBBLE_7_SHIFT 28        // Only three bits available in this one
-NIBBLE_7_MASK 1879048192 // should be 4026531840
-
-BYTE_0_MASK  255
-BYTE_0_SHIFT 0
-
-BYTE_1_MASK  65280
-BYTE_1_SHIFT 8
-
-BYTE_2_MASK  16711680
-BYTE_2_SHIFT 16
-
-BYTE_3_MASK  2130706432 // should be 4278190080
-BYTE_3_SHIFT 24         // only 7 bits in this one
-
 // Basic Skills
 SKILL_EMOTE           1
 SKILL_TRADE           2
@@ -468,179 +427,3 @@ SKILL_MAGIC_TRANSMUTE 343
 SKILL_MAGIC_NATURE    344
 SKILL_MAGIC_ASTRAL    345
 SKILL_MAGIC_DARK      346
-
-// Flags for the magic quests.
-MFLAG_DRANK_POTION         1     // Character drank at least one magic potion as prerequisite for the Mana Seed quest.
-MFLAG_KNOWS_MANASEED       2     // Character has found the Mana Seed.
-MFLAG_TOUCHED_MANASEED     4     // Character has touched the Mana Seed.
-MFLAG_MANASEED_MAXEDOUT    8     // Character has touched the Mana Seed while maxed out on magic.
-
-MFLAG_KNOWS_AULDSBEL       16    // Character has met Auldsbel.
-MFLAG_KNOWS_WYARA          32    // Character has met Wyara.
-MFLAG_KNOWS_SAGATHA        64    // Character has met Sagatha.
-MFLAG_KNOWS_MANAPOTION     128   // Has heard about the Mana Potion.
-
-MFLAG_MANASEED_RUMOUR      256   // Has heard rumour about Mana Seed.
-MFLAG_KNOWS_CUTTREE        512   // Knows about the 'cut the tree' quest.
-MFLAG_DID_CUTTREE          1024  // Did cut off a branch from the druid tree.
-MFLAG_KNOWS_DRUIDTREE      2048  // Knows about the druid tree quest.
-
-MFLAG_KNOWS_IMP            4096  // Knows about the imprisoned forest spirit.
-MFLAG_KNOWS_OLD_WIZARD     8192  // Knows Bjorn's old wizard.
-MFLAG_MADE_CONC_POTION     16384 // Made a concentration potion with T15 and/or T16.
-MFLAG_ELANORE_OMAR         32768 // Told Omar about Elanore's involvement.
-
-MFLAG_KNOWS_UNFOCUS_RECIPE 65536 // Has been told about unfocus by Luca.
-
-// Flags set in the FLAGS variable:
-FLAG_HAS_BOWLER_BURNSDAY 1    // every year's poem at burns day, shannon gives you a bowler hat
-FLAG_OPENED_UNDERGROUND  2    // this flag is a replacement for variable Open_Underground_Palace_Barrier, which was used only as bool
-FLAG_GOT_NAEM_GLOVES     4    // this replaces Naem_Quest_Done, which was used as a bool variable
-FLAG_GOT_GRADUATIONCAP   8    // this is a bit which was to be found in Tut_var second bit
-FLAG_TOWEL_HELPED        16   // gave the towel npc the stuff he wants
-FLAG_TOWEL_COMPLETED     32   // got the towel from the towel npc
-FLAG_ANDRA_HELPED        64   // Knows Andra and agreed to help her
-FLAG_ROSSI_COMPLETED     128  // Completed the Rossi Quest
-FLAG_TUTORIAL_DONE       256  // player completed tutorial (or entered the tutorial area from outside after it was added)
-FLAG_SNOWMAN             512  // player gave candy to the snowman
-FLAG_SANTAS_HELPER       1024 // player gave presents to Santa's helper
-FLAG_HURNSMINE_CHEST     2048 // player opened the chest with the short sword in Hurnscald mines
-FLAG_GOT_BEANIEHAT       4096 // player got Beanie Copter Hat from Milly
-FLAG_DECLINED_BEANIEHAT  8192 // player declined Beanie Copter Hat from Milly
-
-DOCK_tulimshar 1
-DOCK_hurnscald 2
-DOCK_candor    3
-DOCK_nivalis   4
-
-// -----------------
-// -- Easter 2010 --
-// -----------------
-
-// Dealing with the Old Woman's token quest.
-E10_STATE_EGG_MASK 3
-E10_STATE_EGGS_COLLECTED_MASK 31
-E10_STATE_EGGS_COLLECTED_SHIFT 2
-E10_STATE_EGG_COLLECTING 1
-E10_STATE_EGG_COLLECTED 2
-E10_STATE_EGG_REWARDED 3
-E10_STATE_ROSE_MASK 3
-E10_STATE_ROSE_SHIFT 7
-E10_STATE_ROSE_ROSE_USED 1
-E10_STATE_ROSE_ROSE_COMPLETE 2
-E10_STATE_ROSE_RETURNED 3
-
-
-// Dealing with $Easter_2010_Npc_State1.
-E10_TIMER_STATE_EGGS_MASK 31
-E10_TIMER_STATE_TREES_MASK 31
-E10_TIMER_STATE_TREES_SHIFT 5
-E10_TIMER_STATE_DOCTOR_MASK 31
-E10_TIMER_STATE_DOCTOR_SHIFT 10
-E10_EGGS_TIMER_OVERTICK_MASK 31
-E10_EGGS_TIMER_OVERTICK_SHIFT 15
-E10_TREES_OVERTICK_MASK 31
-E10_TREES_OVERTICK_SHIFT 20
-E10_DOCTOR_TIMER_OVERTICK_MASK 31
-E10_DOCTOR_TIMER_OVERTICK_SHIFT 25
-
-
-// Dealing with $Easter_2010_Npc_State2.
-E10_DOCTOR_POSITION_MASK 7
-E10_DOCTOR_POSITION_SHIFT 0
-E10_DOCTOR_POSITION_NULL 0
-E10_DOCTOR_POSITION_BIGTREE 1
-E10_DOCTOR_POSITION_ISLAND 2
-E10_DOCTOR_POSITION_STONES 3
-E10_DOCTOR_POSITION_FRUIT 4
-E10_DOCTOR_POSITION_CAVE 5
-E10_BARRIER_MASK 1
-E10_BARRIER_SHIFT 4
-E10_BARRIER_OPEN 0
-E10_BARRIER_ACTIVE 1
-E10_PRE_WARP_SHIFT 5
-E10_NEEDLE_SHIFT 6
-E10_NEEDLE_MASK 31
-
-// Dealing with the doctor.
-E10_DOCTOR_HELP_STATES_MASK 15
-E10_DOCTOR_HELP_STATES_SHIFT 11
-E10_FLAG_KNOWS_DOCTOR_MASK 1
-E10_FLAG_KNOWS_DOCTOR_SHIFT 10
-E10_FLAG_KNOWS_DOCTOR 1
-E10_FLAG_HELPED_DOCTOR_TREE_MASK 1
-E10_FLAG_HELPED_DOCTOR_TREE_SHIFT 11
-E10_FLAG_HELPED_DOCTOR_TREE 1
-E10_FLAG_HELPED_DOCTOR_ISLAND_MASK 1
-E10_FLAG_HELPED_DOCTOR_ISLAND_SHIFT 12
-E10_FLAG_HELPED_DOCTOR_ISLAND 1
-E10_FLAG_HELPED_DOCTOR_STONES_MASK 1
-E10_FLAG_HELPED_DOCTOR_STONES_SHIFT 13
-E10_FLAG_HELPED_DOCTOR_STONES 1
-E10_FLAG_HELPED_DOCTOR_FRUIT_MASK 1
-E10_FLAG_HELPED_DOCTOR_FRUIT_SHIFT 14
-E10_FLAG_HELPED_DOCTOR_FRUIT 1
-E10_HELPED_DOCTOR_SHIFT 11
-E10_HELPED_DOCTOR_MASK 15
-E10_FLAG_MID_REWARD 1
-E10_FLAG_MID_REWARD_SHIFT 15
-E10_FLAG_MID_REWARD_MASK 1
-E10_FLAG_RETURN_READY 1
-E10_FLAG_RETURN_READY_SHIFT 16
-E10_FLAG_RETURN_READY_MASK 1
-E10_FLAG_USED_FREE_WARP_SHIFT 17
-E10_STATE_REWARDS_SHIFT 18
-E10_STATE_REWARDS_MASK 3
-E10_STATE_REWARD_RABBIT_EARS 1
-E10_STATE_REWARD_EGGSHELL 2
-E10_LOC_NEEDLE_SHIFT 20
-E10_LOC_NEEDLE_MASK 31
-
-// Menus
-E10_STONES_WISP 0
-E10_STONES_SPECTRE 1
-E10_STONES_POLTERGEIST 2
-E10_STONES_SOUL 3
-E10_STONES_HEART 4
-E10_STONES_EAR 5
-E10_STONES_EYE 6
-E10_STONES_BONE 7
-E10_STONES_SKULL 8
-E10_STONES_CRYSTAL 9
-E10_STONES_RAGS 10
-E10_STONES_PETAL 11
-E10_STONES_NEVERMIND 12
-E10_ISLAND_MENU_DEATH_AWE 12
-E10_ISLAND_MENU_SCARED 13
-E10_ISLAND_MENU_WISPS 14
-E10_ISLAND_MENU_OFFER_LIFESTONE 15
-
-// Flags for the battle caves.
-BATTLE_CAVE1 1
-BATTLE_CAVE2 2
-BATTLE_CAVE3 4
-BATTLE_CAVE4 8
-BATTLE_CAVE5 16
-BATTLE_CAVE6 32
-BATTLE_CAVE7 64
-BATTLE_CAVE8 128
-BATTLE_CAVE9 256
-
-// Miscellaneous
-E10_COLLECT_EGGS_ID 1246
-E10_TOKEN_ID 666
-E10_MIDREWARD_ID 1247 // Valentine's Glasses (as described)
-
-// Storage Options
-OPT_STORAGE_CLOSE 1
-OPT_BANK_CLOSE 2
-
-// Currently used by the fluffy hunt (033-1).
-// starts counting with 0
-MAX_HIGH_SCORES 4
-
-// Launcher/Ammo Types
-AMMO_NONE  0
-AMMO_BOW   1
-AMMO_SLING 2
-AMMO_WAND  3