Dungeons

The pick-up guide is built in game (addon/Polestar/Dungeons/Pickup.lua): Dungeons.PickupPlan(key) takes the page's quests that apply to the character (faction, race and class masks through Lookup.QuestBlock, the page's class list), not done, not in the log (those are carried), not closed for good (a quest of the page's closedBy done or in the log: a breadcrumb whose quest is taken, such as Klockmort's Essentials once Essential Artificials is; each accept carries closedBy too, so the Engine passes it once taken on the way), open by max(level, the dungeon's lowest level), picked up outside from an NPC or object (not from an item, not inside), and not a follow-up of another quest of the page; each with its open prerequisites (Lookup.QuestChain: all of pre, one of preAny this character can take, in the order they are done). The giver is Dungeons.Giver(pq, from): the page keeps one (the Codex's first), so a quest several NPCs give goes to the one of the character's side nearest the player (Lookup.QuestEnd, which takes an NPC of the other side only when no other is known and marks it hostile; Tabetha's Task: the mage trainers of both sides), never to one of the other side; the quest card and the map's giver markers show the same giver. Dungeons.PickupGuide(key) orders them as the cheapest path by ns.TravelCost from where the player stands, through every stop, to the entrance (Dungeons.PlanStops(stops, from, finish, travel) -> order, cost: an exact search over the stops done and the last one, up to 12 stops; above that nearest-next, then single stops moved while the path gets shorter). A nearest-next walk with the entrance only appended left a city and came back to it (Thunder Bluff, Orgrimmar, the Undercity, back to Orgrimmar for Ragefire Chasm); the planned path goes Thunder Bluff, the Undercity, Orgrimmar and in. Stops: each prerequisite once, after the one before it in its chain (a full quest step, Lookup.QuestStep, from its giver nearest the player; the player then stands at its turn-in), and a giver once per set of prerequisites its quests wait on (one step with an accept per quest; the giver comes up again for a quest still waiting, and visits to the same giver in a row are one step). The last step lists the carried quests as notes, goes to the entrance and says where the hand-in guide is (a note naming /polestar dungeons <name>). Nothing to take: nil, "nothing". The route is kept per character (CharState().dungeonPickup[key], the stop keys in order) and used when the guide is rebuilt without a position (Dungeons.OrderStops(stops, from, finish, field, key), shared with the hand-in guide). It is a Lookup planner kind (Lookup.RegisterPlanner("pickup", build)): Dungeons.PickUp(key) -> Lookup.Guide("pickup", key) registers it as lookup/pickup/<key> (pack "lookup") and opens it in a new tab, and a saved tab of it is rebuilt at ADDON_LOADED like Lookup's own; it is gated by dungeons.enabled, not lookup.enabled.

The hand-in guide is the run's other half (addon/Polestar/Dungeons/Handin.lua, planner kind handin, lookup/handin/<key>, Dungeons.HandIn(key)). Dungeons.HandinPlan(key) sorts the page's quests in the log: hand (objectives done, by Compat.IsQuestReadyForTurnIn, or a delivery with no objectives; turned in outside at the page's ender, else the Codex ender nearest the player), unfinished, inside (turned in inside the dungeon) and unplaced; it searches no follow-ups, so the page can ask for it on every render. Dungeons.HandinFollowUps(plan) adds the quests the hand quests open (Codex.FollowUps(id): the quests whose pre or preAny name it, one scan of the quest records per id, kept until the quest chunks change): every pre done or handed in here and one of preAny likewise, takeable now (Lookup.QuestBlock: faction, race, class, level), not done or in the log, from the NPC or object a quest it waits on is turned in to or one within 60 seconds of it (ns.TravelCost). Dungeons.HandinGuide(key) makes a stop per turn-in place (its turn-ins, then the follow-ups that same NPC gives) and per other follow-up giver (after the turn-ins it waits on), ordered by Dungeons.OrderStops with no fixed end (CharState().dungeonHandin[key]); the last step lists the rest as notes ("Not finished yet: …", "Turned in inside the dungeon: …"). Nothing routable: nil, "nothing", and Dungeons.HandinText(plan) says why in one line. Dungeons.HandIn puts the guide in the tab of the dungeon's pick-up guide when that one is finished or at its last step (its job ends at the entrance), else in a new tab. A finished pick-up guide's "Guide complete" panel (UI/GuideFrame.lua) offers "Hand in the quests" while the dungeon has quests in the log.

Attunements and keys (addon/Polestar/Dungeons/Attune.lua, planner kind attune, lookup/attune/<key>:<id>). A page's attunement list (Codex, "Dungeons and raids": tools/lib/codex/attunements.js) is read by Dungeons.Attunements(key, faction) (faction "A" | "H" | nil: the entries of that side and the side-free ones). Dungeons.AttunementState(a) gives this character's state per step: a quest done, ready, log, open, locked (a step it waits on, after all, afterAny one, is not done), level, rep (the quest's standing, Compat.GetFactionStanding), na (faction, race or class through Lookup.QuestBlock) or skip (an alternative not taken: of any goals the one whose standing fits best, the highest first; a preAny sibling of a done one); a drop, chest or gift is done once its item is owned (Compat.GetItemCount(id, true), the bank included) or the quest it starts is taken; a standing once reached. The attunement is done when its item is owned (a key, the Drakefire Amulet, Aqual Quintessence) or, item-less, when its goals are done (one of them with any); goalDone with no item says the key was lost. Dungeons.AttuneGuide(key, id) makes a stop per quest still to do (Lookup.QuestStep, with any open prerequisite Lookup.QuestChain finds that the list lacks), each after the stops it waits on, ordered by Dungeons.OrderStops from where the player stands with no fixed end (CharState().dungeonAttune["<key>:<id>"]). Each quest step is whole (accept, objectives, turn-in): Lookup.QuestStep's opts.inside places a giver, target, chest or turn-in without a spawn at the entrance of the instance it is in (the Codex NPC's instance, else the attunement's inside from the cited table) and the step's note says what is inside where; without it such a quest would be a lone "First do the quest" note, which the Engine passes as done. An accept above the character's level stays, the Engine's detail adding "from level N". A drop or chest is a collect step at its NPC or object (inside an instance: at its entrance, with a note naming it), a standing a rep step, a gift a talk step, each after the quest before it in the list; the last step holds the note and the entrance. Nothing left: nil, "done"; the other side's attunement: nil, "nothing". Dungeons.Attune(key, id) opens it in a new tab.