From 1042a3190d14dcac6d7f1944014ae5d41d7ffc0b Mon Sep 17 00:00:00 2001
From: mccarp <35040847+mccarp@users.noreply.github.com>
Date: Mon, 1 Nov 2021 12:32:59 -0400
Subject: [PATCH] lusternia bubblix improvements and compass of the basin
 (#155)

* Added missing bubblixes, created a list of bubblix priorities for shortcuts (going from safest to most dangerous), added compass of the basin support, added walk delays for travel items when they are slowed by enemy travel.
---
 mudlet-mapper.xml | 341 +++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 288 insertions(+), 53 deletions(-)

diff --git a/mudlet-mapper.xml b/mudlet-mapper.xml
index fce9649..89cd45c 100644
--- a/mudlet-mapper.xml
+++ b/mudlet-mapper.xml
@@ -2821,6 +2821,69 @@ end</script>
 						<integer>3</integer>
 					</regexCodePropertyList>
 				</Trigger>
+				<TriggerGroup isActive="yes" isFolder="yes" isTempTrigger="no" isMultiline="no" isPerlSlashGOption="no" isColorizerTrigger="no" isFilterTrigger="no" isSoundTrigger="no" isColorTrigger="no" isColorTriggerFg="no" isColorTriggerBg="no">
+					<name>Delayed bix movement.</name>
+					<script></script>
+					<triggerType>0</triggerType>
+					<conditonLineDelta>0</conditonLineDelta>
+					<mStayOpen>0</mStayOpen>
+					<mCommand></mCommand>
+					<packageName></packageName>
+					<mFgColor>#ff0000</mFgColor>
+					<mBgColor>#ffff00</mBgColor>
+					<mSoundFile></mSoundFile>
+					<colorTriggerFgColor>#000000</colorTriggerFgColor>
+					<colorTriggerBgColor>#000000</colorTriggerBgColor>
+					<regexCodeList />
+					<regexCodePropertyList />
+					<Trigger isActive="yes" isFolder="no" isTempTrigger="no" isMultiline="no" isPerlSlashGOption="no" isColorizerTrigger="no" isFilterTrigger="no" isSoundTrigger="no" isColorTrigger="no" isColorTriggerFg="no" isColorTriggerBg="no">
+						<name>Teleport Delays</name>
+						<script>mmp.customwalkdelay(10)</script>
+						<triggerType>0</triggerType>
+						<conditonLineDelta>0</conditonLineDelta>
+						<mStayOpen>0</mStayOpen>
+						<mCommand></mCommand>
+						<packageName></packageName>
+						<mFgColor>#ff0000</mFgColor>
+						<mBgColor>#ffff00</mBgColor>
+						<mSoundFile></mSoundFile>
+						<colorTriggerFgColor>#000000</colorTriggerFgColor>
+						<colorTriggerBgColor>#000000</colorTriggerBgColor>
+						<regexCodeList>
+							<string>You run your fingers across the surface of .* and still your mind, preparing for the journey ahead.</string>
+							<string>^You reach out and touch the \w+-facing landmark of the Compass of the Basin, and the spinning needle within fixes on that direction. The compass begins vibrating sympathetically with strands of aether\.$</string>
+						</regexCodeList>
+						<regexCodePropertyList>
+							<integer>1</integer>
+							<integer>1</integer>
+						</regexCodePropertyList>
+					</Trigger>
+					<Trigger isActive="yes" isFolder="no" isTempTrigger="no" isMultiline="no" isPerlSlashGOption="no" isColorizerTrigger="no" isFilterTrigger="no" isSoundTrigger="no" isColorTrigger="no" isColorTriggerFg="no" isColorTriggerBg="no">
+						<name>Immediately retry on failed teleport</name>
+						<script>if mmp.autowalking then
+  mmp.customwalkdelay(0)
+  mmp.move()
+end</script>
+						<triggerType>0</triggerType>
+						<conditonLineDelta>0</conditonLineDelta>
+						<mStayOpen>0</mStayOpen>
+						<mCommand></mCommand>
+						<packageName></packageName>
+						<mFgColor>#ff0000</mFgColor>
+						<mBgColor>#ffff00</mBgColor>
+						<mSoundFile></mSoundFile>
+						<colorTriggerFgColor>#000000</colorTriggerFgColor>
+						<colorTriggerBgColor>#000000</colorTriggerBgColor>
+						<regexCodeList>
+							<string>Your action disrupts your concentration and you cease reaching out to harness</string>
+							<string>You cease concentrating on traveling the planar paths.</string>
+						</regexCodeList>
+						<regexCodePropertyList>
+							<integer>2</integer>
+							<integer>3</integer>
+						</regexCodePropertyList>
+					</Trigger>
+				</TriggerGroup>
 			</TriggerGroup>
 			<TriggerGroup isActive="yes" isFolder="yes" isTempTrigger="no" isMultiline="no" isPerlSlashGOption="no" isColorizerTrigger="no" isFilterTrigger="no" isSoundTrigger="no" isColorTrigger="no" isColorTriggerFg="no" isColorTriggerBg="no">
 				<name>Imperian</name>
@@ -5688,15 +5751,23 @@ function mmp.startup()
   private_settings["medallion"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Medallion?", nil, {lusternia = true})
   
   --Lusternia Bubblixes
+  private_settings["twist"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Mt. Dio Bix?", nil, {lusternia = true})
+  private_settings["figurine"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Icewynd Bix?", nil, {lusternia = true})
+  private_settings["periscope"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Aquagoria Bix?", nil, {lusternia = true})
+  private_settings["pebble"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Lyraa Bix?", nil, {lusternia = true})
+  private_settings["shard"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Xion Bix?", nil, {lusternia = true})
+  private_settings["tibia"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Cankermore Bix?", nil, {lusternia = true})
+  private_settings["mud"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Mucklemarsh Bix?", nil, {lusternia = true})
+  private_settings["cookie"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Crumkindivia Bix?", nil, {lusternia = true})
+  private_settings["icicle"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Frosticia Bix?", nil, {lusternia = true})
+  private_settings["screwdriver"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Facility Bix?", nil, {lusternia = true})
+  private_settings["snowglobe"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Tree of Trees Bix?", nil, {lusternia = true})
+  private_settings["head"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Bottledowns Bix?", nil, {lusternia = true})
+  private_settings["wheel"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Dramube Bix?", nil, {lusternia = true})
   
-  private_settings["tibia"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Tibia?", nil, {lusternia = true})
-  private_settings["mud"] = createOption(false, mmp.setMud, {"boolean"}, "Make use of your Mud?", nil, {lusternia = true})
-  private_settings["cookie"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Cookie?", nil, {lusternia = true})
-  private_settings["icicle"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Icicle?", nil, {lusternia = true})
-  private_settings["screwdriver"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Screwdriver?", nil, {lusternia = true})
-  private_settings["snowglobe"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Snowglobe?", nil, {lusternia = true})
-  private_settings["head"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Doll's Head?", nil, {lusternia = true})
-  private_settings["wheel"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Quartz Wheel?", nil, {lusternia = true})
+  --lusternia athergoop setButtons 
+  
+  private_settings["buttons"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of Aethergoop Buttons?", nil, {lusternia = true})
   
   --Lusternia Curio collections
   
@@ -5706,7 +5777,7 @@ function mmp.startup()
   private_settings["figurecurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Figure curios?", nil, {lusternia = true})
   private_settings["flowercurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Flower curios?", nil, {lusternia = true})
   private_settings["fluttercurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Flutter curios?", nil, {lusternia = true})
-  private_settings["toolcurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Tool curios]?", nil, {lusternia = true})
+  private_settings["toolcurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Tool curios?", nil, {lusternia = true})
   private_settings["vernalcurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Vernal curios?", nil, {lusternia = true})
   private_settings["utensilcurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Utensil curios?", nil, {lusternia = true})
   private_settings["toycurio"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Toy curios?", nil, {lusternia = true})
@@ -5721,6 +5792,10 @@ function mmp.startup()
   private_settings["mantle"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Mantle?", nil, {lusternia = true})
   private_settings["key"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Make use of your Key?", nil, {lusternia = true})
   
+  --Lusternia other travel things
+  private_settings["compass"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Use the Compass of the Basin?", nil, {lusternia = true})
+  
+  
   --I have no idea what this does tbh
   
   private_settings["caravan"] = createOption(false, mmp.changeBoolFunc, {"boolean"}, "Walk caravans?", nil, {imperian = true})
@@ -7105,32 +7180,10 @@ registerAnonymousEventHandler("mmp link externals", "mmp.achaeaBetterWings")</sc
 					<packageName></packageName>
 					<script>registerAnonymousEventHandler("mmp link externals", "mmp.addWingsLusternia")
 
-local function linkBubblix(area, entranceRoom, command)
-  -- always add this link to allow pathfinding to the bubble regardless of indoor/outdoor
-  mmp.tempSpecialExit(148, entranceRoom, command)
-  -- always add this link to allow pathfinding from the bubbe regardless of indoor/outdoor
-  mmp.tempSpecialExit(entranceRoom, 6831, command)
-  if mmp.usebubblix() then
-    if not table.contains(gmcp.Room.Info.details, "an Aetherbubble") then
-      -- we are not in an Aetherbubble and could use a bubblix, so allow its use from here
-      mmp.tempSpecialExit(entranceRoom, command)
-    elseif gmcp.Room.Info.area == area then
-      -- we are in an Aetherbubble and it's the one the bubblix belongs to and we could use a bubblix, so allow its use from here
-      mmp.tempSpecialExit(6831, command)
-    end
-  end
-end
-
 function mmp.addWingsLusternia()
   if mmp.game ~= "lusternia" then
     return
   end
-  --that dorky prism
-  if mmp.useprism() then
-    if mmp.settings.prism then
-      mmp.tempSpecialExit(6182, "touch prism")
-    end
-  end
   --items that use standard bix rules
   if mmp.usebix() then
     --cubix and things
@@ -7162,7 +7215,13 @@ function mmp.addWingsLusternia()
     if mmp.settings.key then
       mmp.tempSpecialExit(18732, "touch key")
     end
-    --curio collections!
+  end
+  --things which use prism rules
+  if mmp.useprism() then
+    if mmp.settings.prism then
+      mmp.tempSpecialExit(6182, "touch prism")
+    end
+    --curio collections
     if mmp.settings.bonecurio then
       mmp.tempSpecialExit(28613, "curio collection activate bone")
     end
@@ -7198,29 +7257,99 @@ function mmp.addWingsLusternia()
     end
   end
   --all the bubblixes!
-  if mmp.settings.screwdriver then
-    linkBubblix("the Facility", 10185, "touch screwdriver")
-  end
-  if mmp.settings.wheel then
-    linkBubblix("the Dramube Triangle", 10509, "touch wheel")
-  end
-  if mmp.settings.mud then
-    linkBubblix("Mucklemarsh", 9985, "touch mud")
-  end
-  if mmp.settings.snowglobe then
-    linkBubblix("the Great Spirit Tree", 10992, "shake snowglobe")
-  end
-  if mmp.settings.cookie then
-    linkBubblix("Crumkindivia", 9888, "touch cookie")
-  end
-  if mmp.settings.head then
-    linkBubblix("the Bubble of Bottledowns", 11811, "touch doll")
+  local bubblixes =
+    {
+      {
+        setting = "figurine",
+        item = "icebix",
+        room = 23187,
+        areas = {"Northern Icewynd Mountains", "Southern Icewynd Mountains"},
+      },
+      {setting = "twist", item = "diobix", room = 18203, areas = {"Mount Dio"}},
+      {setting = "snowglobe", item = "treebix", room = 10992, areas = {"the Great Spirit Tree"}},
+      {setting = "periscope", item = "aquabix", room = 36073, areas = {"Aquagoria"}},
+      {setting = "pebble", item = "lyraabix", room = 33825, areas = {"Lyraa Ey Rielys"}},
+      {setting = "shard", item = "xionbix", room = 12652, areas = {"the Workshop of Xion"}},
+      {setting = "cookie", item = "crumbix", room = 9888, areas = {"Crumkindivia"}},
+      {setting = "wheel", item = "drambix", room = 10509, areas = {"the Dramube Triangle"}},
+      {setting = "head", item = "bottlebix", room = 11811, areas = {"the Bubble of Bottledowns"}},
+      {setting = "icicle", item = "frostbix", room = 10457, areas = {"Frosticia"}},
+      {setting = "screwdriver", item = "facbix", room = 10185, areas = {"the Facility"}},
+      {setting = "mud", item = "mucklebix", room = 9985, areas = {"Mucklemarsh"}},
+      {
+        setting = "tibia",
+        item = "cankerbix",
+        room = 11600,
+        areas = {"the Cankermore Battlegrounds"},
+      },
+    }
+  local shortcutCreated = false
+  for _, bubblix in pairs(bubblixes) do
+    if mmp.settings[bubblix.setting] then
+      local command = "touch " .. bubblix.item
+      if not shortcutCreated then
+        --for the first bubblix in the list, let it be used as a shortcut to aetherplex.
+        mmp.tempSpecialExit(bubblix.room, 6831, command)
+        shortcutCreated = true
+      end
+      --for every bix, create an exit from outside aetherplex to the bubble.
+      mmp.tempSpecialExit(148, bubblix.room, command)
+      if mmp.usebubblix() then
+        if table.contains(bubblix.areas, gmcp.Room.Info.area) then
+          mmp.tempSpecialExit(mmp.currentroom, 6831, command)
+        elseif not table.contains(gmcp.Room.Info.details, "an Aetherbubble") then
+          mmp.tempSpecialExit(mmp.currentroom, bubblix.room, command)
+        end
+      end
+    end
   end
-  if mmp.settings.icicle then
-    linkBubblix("Frosticia", 10457, "touch icicle")
+  --one use button travel!
+  if mmp.settings.buttons then
+    local colors =
+      {
+        blue = 36073,
+        brown = 11811,
+        black = 11600,
+        yellow = 9888,
+        red = 10509,
+        steel = 10185,
+        white = 10457,
+        purple = 47812,
+        green = 9985,
+        crystal = 12652,
+        wooden = 10992,
+      }
+    local exitScript = [[script:sendAll("outr %sbutton", "touch %sbutton", false)]]
+    if
+      table.contains(gmcp.Room.Info.details, "the Prime Material Plane") and
+      table.contains(gmcp.Room.Info.details, "outdoors")
+    then
+      for color, room in pairs(colors) do
+        mmp.tempSpecialExit(mmp.currentroom, room, exitScript:format(color, color), 20)
+      end
+    else
+      for color, room in pairs(colors) do
+        mmp.tempSpecialExit(148, room, exitScript:format(color, color), 20)
+      end
+    end
   end
-  if mmp.settings.tibia then
-    linkBubblix("the Cankermore Battlegrounds", 11600, "touch tibia")
+  --basin of life specific travel devices
+  if mmp.settings.compass then
+    local startingRoom = mmp.lusterniaInBasin() and mmp.currentroom or 148
+    local compassPoints =
+      {
+        north = 21695,
+        northeast = 10742,
+        northwest = 6546,
+        east = 9789,
+        southeast = 14998,
+        south = 10670,
+        southwest = 19613,
+        west = 20037,
+      }
+    for direction, destinationRoom in pairs(compassPoints) do
+      mmp.tempSpecialExit(startingRoom, destinationRoom, "Touch compass " .. direction, 40)
+    end
   end
   mmp.clearpathcache()
 end</script>
@@ -10723,6 +10852,112 @@ function mmp.lockpaths(lock)
     end
   end
   mmp.echo((lock and "Locked " or "Unlocked ") .. count .. " pathfinding exits.")
+end</script>
+						<eventHandlerList />
+					</Script>
+					<Script isActive="yes" isFolder="no">
+						<name>Lusternia basin areas</name>
+						<packageName></packageName>
+						<script>local basinAreas =
+  {
+    ["Ackleberry Highway"] = true,
+    ["Alabaster Road"] = true,
+    ["Avechna's Peak"] = true,
+    ["Avechna's Teeth"] = true,
+    ["Balach Swamp"] = true,
+    ["Bondero Bay"] = true,
+    ["Caoimhe Dell"] = true,
+    ["Cay of Cloadahi"] = true,
+    ["Emerald Road"] = true,
+    ["Epicure's Alley"] = true,
+    ["Glomdoring Forest"] = true,
+    ["Great Southern Highway"] = true,
+    ["Highwater Keep"] = true,
+    ["Irshaw Heights"] = true,
+    ["Mornhai Sanctuary"] = true,
+    ["Mount Krog"] = true,
+    ["Mount Wend"] = true,
+    ["Mount Zoaka"] = true,
+    ["Old Imperial Road"] = true,
+    ["Snow Valley"] = true,
+    ["Spectre Isle"] = true,
+    ["St. Gathlyn's Orphanage for the Dispossessed"] = true,
+    ["The Emerald Enclave"] = true,
+    ["Tolborolla Valley"] = true,
+    ["Verasavir Valley"] = true,
+    ["Waste Storage Facility"] = true,
+    ["Wyrden Isle"] = true,
+    ["the Base of Operations"] = true,
+    ["the Blasted Land"] = true,
+    ["the Carai Caroo"] = true,
+    ["the Caverns of Muhanlesh"] = true,
+    ["the Caves of Hhuhur"] = true,
+    ["the Chancel of Clangoran Mysteries"] = true,
+    ["the City of Gaudiguch"] = true,
+    ["the City of Hallifax"] = true,
+    ["the City of Magnagora"] = true,
+    ["the City of New Celest"] = true,
+    ["the Clarramore Cloud Gardens"] = true,
+    ["the Crimson Lady"] = true,
+    ["the Divine Luck Club"] = true,
+    ["the Dracnari Nomad Camp"] = true,
+    ["the Empress' Last Breath"] = true,
+    ["the Estengare River"] = true,
+    ["the Feyranti Estate"] = true,
+    ["the Floating Island of the Forgotten"] = true,
+    ["the Gloriana River"] = true,
+    ["the Grand Junction Bazaar"] = true,
+    ["the Grey Moors"] = true,
+    ["the Hifarae Hills"] = true,
+    ["the Inner Sea"] = true,
+    ["the Isle of Itecia"] = true,
+    ["the Isle of Nyalia"] = true,
+    ["the Isle of Olimsito"] = true,
+    ["the Isle of Vesucia"] = true,
+    ["the Kelpie Maiden"] = true,
+    ["the Kiakodan Nature Reserve"] = true,
+    ["the Lucidian Mesa Compound"] = true,
+    ["the Meliashmora of Imperial Secrets"] = true,
+    ["the New Celest sewer system"] = true,
+    ["the Northern Mountains"] = true,
+    ["the Oleanvir Valley"] = true,
+    ["the Presidio of the Damned"] = true,
+    ["the Razine Mountain Range"] = true,
+    ["the Rhizoda Mangrove"] = true,
+    ["the Ruins of Shallach"] = true,
+    ["the Scorpion Caverns"] = true,
+    ["the Sea of Despair"] = true,
+    ["the Serenwilde Forest"] = true,
+    ["the Shallach River"] = true,
+    ["the Shallamurine Cathedral"] = true,
+    ["the Skarch Desert"] = true,
+    ["the Southern Mountains"] = true,
+    ["the Tainted Broadcast Centre"] = true,
+    ["the Tar Pits"] = true,
+    ["the Tosha Monastery"] = true,
+    ["the Transcendental Fulcrux"] = true,
+    ["the Triple Junction Inn"] = true,
+    ["the Upper Peaks of the Razines"] = true,
+    ["the Upper Peaks of the Southern Mountains"] = true,
+    ["the Village of Acknor"] = true,
+    ["the Village of Angkrag"] = true,
+    ["the Village of Dairuchi"] = true,
+    ["the Village of Delport"] = true,
+    ["the Village of Duum"] = true,
+    ["the Village of Estelbar"] = true,
+    ["the Village of Paavik"] = true,
+    ["the Village of Rikenfriez"] = true,
+    ["the Village of Rockholm"] = true,
+    ["the Village of Shanthmark"] = true,
+    ["the Village of Southgard"] = true,
+    ["the Village of Stewartsville"] = true,
+    ["the Village of Talthos"] = true,
+    ["the i'Xiia Asylum"] = true,
+    ["the sewers of Magnagora"] = true,
+  }
+
+function mmp.lusterniaInBasin()
+  return basinAreas[gmcp.Room.Info.area] or false
 end</script>
 						<eventHandlerList />
 					</Script>