Difference between pages "Quest Tracking Preferences" and "Can faxbot"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>Paladinwhite
 
 
Line 1: Line 1:
{{TOCright}}
+
{{
KoLMafia internally tracks progress for a number of quests. These are stored as preferences in settings\[charactername]_prefs.
+
#vardefine:name|can_faxbot}}{{
 +
#vardefine:return_type|boolean}}{{
  
==Quests Granted by Familiars==
+
FunctionPage|
===questF01Primordial===
+
name={{#var:name}}|
=unstarted
 
===questF02Hyboria===
 
=unstarted
 
===questF03Future===
 
=unstarted
 
===questF04Elves===
 
=unstarted
 
===questF05Clancy===
 
=unstarted
 
  
==Guild Quests==
+
function1={{Function|
===questG01Meatcar===
+
name={{#var:name}}|
Possible values: unstarted, started
+
return_type={{#var:return_type}}|
 +
parameter1={{Param|monster|mob}}||
 +
p1desc={{Pspan|mob}} is the monster for which to check.|
 +
}}|
  
===questG02Whitecastle===
+
function_description=Checks to see if {{Pspan|mob}} can be faxed by any of the faxbots known to KoLmafia. This does not check if the faxbot(s) are online.<ref>https://sourceforge.net/p/kolmafia/code/20614/tree/src/net/sourceforge/kolmafia/textui/RuntimeLibrary.java#l4753</ref>|
=unstarted
 
===questG03Ego===
 
=started
 
===questG04Nemesis===
 
=started
 
===questG05Dark===
 
=unstarted
 
===questG06Delivery===
 
=unstarted
 
  
==Quests Granted by Items==
+
code1={{CodeSample|
===questI01Scapegoat===
+
title=Code Samples|
=unstarted
+
description=This will acquire a copy of a scary pirate if you can get one.|
===questI02Beat===
+
code=
=unstarted
 
 
 
==Council Quests==
 
===questL02Larva===
 
=finished
 
===questL03Rat===
 
=finished
 
===questL04Bat===
 
=finished
 
===questL05Goblin===
 
=finished
 
===questL06Friar===
 
=finished
 
===questL07Cyrptic===
 
=finished
 
===questL08Trapper===
 
 
 
questL08Trapper tracks the player's progress in the {{kolwiki|Mt._McLargeHuge_Quest|Mt. McLargeHuge Quest}}.
 
 
 
Possible values: unstarted, started, step1-step5, finished
 
* unstarted: quest not yet received from the Council
 
* started: quest received from the Council
 
* step1: cheese and ore requested by the Trapper
 
* step2: cheese and ore returned to the Trapper
 
* step3: discovered the stairs up to the Mist-Shrouded Peak (via either route)
 
* step4: fought at least one yeti
 
* step5: defeated the monster at the top of the Peak
 
* finished: returned the fur to the Trapper (quest complete)
 
 
 
===questL09Lol===
 
=unstarted
 
===questL09Topping===
 
questL08Trapper tracks the player's progress in the {{kolwiki|Orc_Chasm_Quest|Orc Chasm Quest}}.
 
 
 
Possible values: unstarted, started, step1-step2, finished
 
* unstarted: quest not yet received from the Council
 
* started: quest received from the Council
 
* step1: bridge built
 
* step2: like, totally got the deets from the Highland Lord
 
* finished: quest complete
 
 
 
====booPeakProgress====
 
booPeakProgress tracks the hauntedness level of {{kolwiki|A-boo Peak}}. A value of 18, for instance, indicates that A-boo Peak is 18% haunted.
 
 
 
Possible values: 0 - 100
 
 
 
====chasmBridgeProgress====
 
chasmBridgeProgress tracks the player's progress in building a bridge across the {{kolwiki|Orc Chasm}}. A value of 10, for instance, indicates that the bridge is 10 planks long.
 
 
 
Possible values: 0 - 30
 
====oilPeakProgress====
 
oilPeakProgress tracks the remaining pressure at {{kolwiki|Oil Peak}}. It decreases as the player reduces the pressure in the zone.
 
 
 
Possible values: 0.00 - 310.66
 
* 310.66: Pressure not yet reduced
 
* 0.00: Subquest completed
 
 
 
====twinPeakProgress====
 
twinPeakProgress is a nibble bitmask with least significant bit set for the first choice and the most significant for the fourth. You can parse this with bitwise operators. Here's some code that demonstrates how to use it.
 
 
 
<syntaxhighlight>
 
void comma(buffer b, string s) {
 
if(length(b) > 0)
 
b.append(", ");
 
b.append(s);
 
}
 
 
 
boolean mysterious(int progress, int c) {
 
return (progress & (1 << c)) == 0;
 
}
 
 
 
string twinPeak() {
 
int p = get_property("twinPeakProgress").to_int();
 
buffer need;
 
if(mysterious(p, 0)) need.comma("4 Stench Resistance");
 
if(mysterious(p, 1)) need.comma("+50% Item Drop");
 
if(mysterious(p, 2)) need.comma("Jar of Oil");
 
// Only check for final if first three complete
 
if(length(need) == 0) {
 
if(mysterious(p, 3))
 
return "Need +40% Initiative";
 
return "Twin Peak Completed";
 
}
 
return "Need " + need;
 
}
 
</syntaxhighlight>
 
 
 
===questL10Garbage===
 
 
 
questL10Garbage tracks the player's progress in {{kolwiki|Giant_Trash_Quest|the Giant Trash Quest}}.
 
 
 
Possible values: unstarted, started, step1-step9, finished
 
* unstarted: quest not yet received from the Council
 
* started: quest received from the Council
 
* step2: giant beanstalk grown
 
* step3 - step6: four Immateria acquired
 
* step7: S.O.C.K. acquired ({{kolwiki|The_Castle_in_the_Clouds_in_the_Sky_(Basement)|Castle Basement}} open)
 
* step8: {{kolwiki|The_Castle_in_the_Clouds_in_the_Sky_(Basement)|Castle Ground Floor}} open
 
* step9: {{kolwiki|The_Castle_in_the_Clouds_in_the_Sky_(Basement)|Castle Top Floor}} open
 
* finished: quest complete
 
 
 
===questL11MacGuffin===
 
=finished
 
 
 
====questL11Black====
 
Tracks Black Market discovery
 
 
 
Possible values: unstarted, started, step1-step2, finished
 
 
 
* unstarted: quest not yet received
 
* started:  ???
 
* step1: ???
 
* step2: Black Market found
 
* finished: ???
 
 
 
====questL11Manor====
 
questL11Manor tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin#Spookyraven_quest_.28In_a_Manor_of_Spooking|Spookyraven Manor portion of the Holy Macguffin quest}}.
 
 
 
Possible values: unstarted, step1-step3, finished
 
 
 
*unstarted: quest not yet received
 
*started: quest received, by reading your father's MacGuffin diary
 
*step1: Spookyraven Manor Cellar opened
 
*step2: recipe: mortar-dissolving solution read
 
*step3: Suspicious Masonry demolished
 
*finished: Lord Spookyraven defeated
 
 
 
=====wineCellarProgress=====
 
=3
 
 
 
====questL11Desert====
 
Explore the Arid, Extra-Dry Desert to find the pyramid mentioned in your father's journal.
 
 
 
Possible values:
 
 
 
* unstarted:
 
* started: quest started by reading your father's MacGuffin diary
 
* step1:
 
 
 
====questL11Pyramid====
 
questL11Pyramid tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin#A_Small_Pyramid|Pyramid portion of the Holy Macguffin quest}}.
 
 
 
Possible values: unstarted, started, step1-step3, finished
 
* unstarted: Pyramid not yet discovered
 
* started: Pyramid discovered
 
* step1: Middle Chamber opened
 
* step2: The Lower Chambers opened
 
* step3: Control Room opened
 
* finished: MacGuffin retrieved (quest complete)
 
 
 
=====gnasirProgress=====
 
gnasirProgress is a nibble bitmask with one bit for each possible way you can advance {{kolwiki|Quest_for_the_Holy_MacGuffin|Gnasir's quest}}. You can parse this with bitwise operators. Here's some code that demonstrates how to use it.
 
 
<syntaxhighlight>
 
<syntaxhighlight>
int gnasirProgress = get_property("gnasirProgress").to_int();
+
if( get_property("_photocopyUsed")=="false" && can_faxbot($monster[scary pirate]) )
buffer gnasir;
+
faxbot($monster[scary pirate]);
if((gnasirProgress & 1) == 0)
 
print("Gnasir wants a stone rose");
 
if((gnasirProgress & 2) == 0)
 
print("Gnasir wants a can of black paint");
 
if((gnasirProgress & 4) == 0)
 
print("Gnasir wants a killing jar");
 
if((gnasirProgress & 8) == 0)
 
print("Gnasir wants a 15 worm-riding manual page");
 
if((gnasirProgress & 16) == 0)
 
print("You need to use a drum machine to ride the worm");
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
}}|
 +
see_also={{SeeAlso|faxbot|is_online}}|
 +
}}
 +
==References==
 +
<references/>
  
====questL11Ron====
+
[[Category:Miscellaneous Functions]]
Ron Copperhead
 
 
 
=====zeppelinProtestors=====
 
Tracks protesters removed
 
 
 
====questL11Shen====
 
Shen Copperhead
 
 
 
====questL11Palindome====
 
questL11Palindome tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin#The_Palindome|Palindome portion of the Never Odd or Even quest}}.
 
 
 
Possible values: unstarted, started, step1-step5, finished
 
* unstarted:
 
* started: spent at least one turn Inside the Palindome
 
* step1: arranged the photos in Dr. Awkward's office
 
* step2: read 2 Love Me, Vol. 2
 
* step3: met Mr. Alarm in his office (received the wet stunt nut stew quest)
 
* step4: cooked wet stunt nut stew
 
* step5: returned the stew to Mr. Alarm
 
* finished: defeated Dr. Awkward
 
 
 
====questL11Worship====
 
=finished
 
 
 
=====questL11Business=====
 
=====questL11Curses=====
 
=====questL11Doctor=====
 
=====questL11Spare=====
 
 
 
 
 
=====hiddenApartmentProgress=====
 
hiddenApartmentProgress tracks progress through the {{kolwiki|Hidden Apartment Building}} during the Quest for the Holy MacGuffin.
 
 
 
Possible values: 0, 1, 6 - 8
 
* 0: Haven't opened the Hidden Apartment Building
 
* 1: Hidden Apartment Building is open for adventuring
 
* 6: Encountered the Protector Spirit
 
* 7: Found the stone sphere
 
* 8: Placed the stone sphere in the relevant overgrown shrine
 
 
 
=====hiddenBowlingAlleyProgress=====
 
hiddenBowlingAlleyProgress tracks progress through the {{kolwiki|Hidden Bowling Alley}} during the Quest for the Holy MacGuffin.
 
 
 
Possible values: 0, 1, 6 - 8
 
* 0: Haven't opened the Hidden Bowling Alley
 
* 1: Hidden Bowling Alley is open for adventuring
 
* 2-5: Number of times bowled is 1 less than hiddenBowlingAlleyProgress
 
* 6: Encountered the Protector Spirit
 
* 7: Found the stone sphere
 
* 8: Placed the stone sphere in the relevant overgrown shrine
 
 
 
=====hiddenHospitalProgress=====
 
hiddenHospitalProgress tracks progress through the {{kolwiki|Hidden Hospital}} during the Quest for the Holy MacGuffin.
 
 
 
Possible values: 0 - 8
 
* 0: Haven't opened the Hidden Hospital
 
* 1: Hidden Hospital is open for adventuring, but haven't bowled.
 
* 6: Encountered the Protector Spirit
 
* 7: Found the stone sphere
 
* 8: Placed the stone sphere in the relevant overgrown shrine
 
 
 
=====hiddenOfficeProgress=====
 
hiddenOfficeProgress tracks progress through the {{kolwiki|Hidden Office Building}} during the Quest for the Holy MacGuffin.
 
 
 
Possible values: 0, 1, 6 - 8
 
* 0: Haven't opened the Hidden Office Building
 
* 1: Hidden Office Building is open for adventuring
 
* 6: Encountered the Protector Spirit
 
* 7: Found the stone sphere
 
* 8: Placed the stone sphere in the relevant overgrown shrine
 
 
 
=====hiddenTavernUnlock=====
 
hiddenTavernUnlock tracks whether or not you have unlocked the {{kolwiki|Hidden Tavern}} during the Quest for the Holy MacGuffin.
 
 
 
Possible values: 0 - N
 
* When the value is equal to your number of ascensions, the Tavern is unlocked
 
* When the value is any other number, the Tavern is locked
 
 
 
===questL12War===
 
questL12War tracks progress during the {{kolwiki|Mysterious Island Quest}}.
 
 
 
Possible values: unstarted, started, step1, finished
 
* unstarted: quest not yet received from the Council
 
* started: quest received
 
* step1: War started
 
* finished: War ended; boss defeated (quest complete)
 
 
 
====warProgress====
 
Possible values for the progress of the {{kolwiki|Mysterious Island Quest|Isle War}}:
 
*unstarted: We can still visit the small version of the Mysterious Island
 
*started: The war is in progress
 
*finished: The final boss or bosses were defeated
 
 
 
====sideDefeated====
 
Which side of the {{kolwiki|Mysterious Island Quest|Isle War}} was defeated during the Level 12 quest.
 
 
 
Possible values:
 
*neither
 
*hippies
 
*fratboys
 
*both
 
 
 
===questL13Final===
 
Progress for the {{kolwiki|Naughty Sorceress Quest}}.
 
 
 
*unstarted - Lair is closed
 
*started - Contest booth is available
 
*step1 - Coronation ceremony
 
*step2 - Hedge maze
 
*step3 - Tower door
 
*step4 - Wall of skin
 
*step5 - Wall of meat
 
*step6 - Wall of bone
 
*step7 - Mirror
 
*step8 - Your Shadow
 
*step9 - Naughty Sorceress
 
*step10 - Prism awaits breaking
 
*finished - Gash is available
 
 
 
===questL13Warehouse===
 
the final quest if you ascend as {{kolwiki|Actually Ed the Undying}} where you adventure in {{kolwiki|The Secret Council Warehouse}}.
 
*unstarted
 
*started
 
*finished
 
Current progress in the warehouse is tracked in warehouseProgress.
 
 
 
==Miscellaneous Quests==
 
===questM01Untinker===
 
=finished
 
===questM02Artist===
 
=unstarted
 
===questM03Bugbear===
 
=unstarted
 
===questM04Galaktic===
 
=started
 
===questM05Toot===
 
=unstarted
 
===questM06Gourd===
 
=unstarted
 
===questM07Hammer===
 
=unstarted
 
===questM08Baker===
 
=unstarted
 
===questM09Rocks===
 
=unstarted
 
===questM10Azazel===
 
=finished
 
===questM11Postal===
 
=unstarted
 
===questM12Pirate===
 
questM12Pirate tracks the player's progress in the {{kolwiki|Cap'm Caronch Quest}}.
 
 
 
Possible values: unstarted, started, step1-stepX, finished
 
 
 
*unstarted:
 
*started: Cap'm Caronch's Map found
 
*step1: acquired Cap'm Caronch's nasty booty from the booty crab
 
*step2: received the Orcish Frat House blueprints
 
*step3: retrieved Cap'm Caronch's dentures from the Frat House
 
*step4: returned the dentures to the Cap'm and accepted the beer pong challenge
 
*step5: won a game of beer pong
 
 
 
===questM13Escape===
 
=unstarted
 
===questM14Bounty===
 
=unstarted
 
===questM15Lol===
 
=started
 
===questM16Temple===
 
Dakota Fanning's quest to find the Hidden Temple
 
 
 
===questM17Babies===
 
Lady Spookyraven's Babies
 
 
 
===questM18Swamp===
 
Marty and His Swamp Problems
 
 
 
===questM19Hippy===
 
Hippy Give a Hippy a Boat...
 
 
 
===questM20Necklace===
 
questM20Necklace tracks the player's progress in {{kolwiki|Spookyraven_Manor_Quest#Lady_Spookyraven.27s_Necklace_.28First_Floor.29|retrieving Lady Spookyraven's necklace}}.
 
 
 
Possible values: unstarted, started, step1-stepX, finished
 
* unstarted: quest not yet received
 
* started: quest received from the telegram
 
* step1: billiards room key found
 
* step2: pool skill increased at least once*
 
* step3: library key found
 
* step4: necklace found
 
* finished: necklace returned to Lady Spookyraven (quest complete)
 
 
 
<nowiki>*Needs spading.</nowiki>
 
 
 
===questM21Dance===
 
Lady Spookyraven's Dance
 
 
 
===questM22Shirt===
 
The Shirt Off His Lack of Back
 
 
 
===questM23Meatsmith===
 
Helping Make Ends Meat
 
* unstarted
 
* started
 
* step1 - Got a {{kolwiki|check to the Meatsmith}}.
 
* finished - Returned {{kolwiki|check to the Meatsmith}} to the Meatsmith.
 
 
 
===questM24Doc===
 
What's Up, Doc?
 
* unstarted
 
* started
 
* step1 - Collected the Herbs and need to return them to Doc Galaktik
 
* finished
 
 
 
==Sea Quests==
 
===questS01OldGuy===
 
=finished
 
===questS02Monkee===
 
=unstarted
 
 
 
When Mom is rescued the Quest is completed
 
 
 
=finished
 
 
 
====merkinQuestPath====
 
merkinQuestPath indicates which path the player has chosen in the {{kolwiki|Mer-Kin Deepcity}}, during the {{kolwiki|Sea Monkees Quest}}.
 
 
 
Possible values:
 
* none: Player has not yet chosen a path
 
* gladiator: Player will fight Yog-Urt, Elder Goddess of Hatred
 
* scholar: Player will fight Shub-Jigguwatt, Elder God of Violence
 
* done: Player has completed the Sea Monkees Quest
 
 
 
====skateParkStatus====
 
 
 
==Bug Bear Invasion Properties==
 
 
 
===mothershipProgress===
 
mothershipProgress tracks progress of level completion in the {{kolwiki|Bugbear Mothership}}. It goes from 0 to 3 as that level is cleared.
 
 
 
Possible values: 0-3
 
 
 
===statusEngineering===
 
===statusGalley===
 
===statusMedbay===
 
===statusMorgue===
 
===statusNavigation===
 
===statusScienceLab===
 
===statusSonar===
 
===statusSpecialOps===
 
===statusWasteProcessing===
 
All of these work the same way.
 
*0-x (integers): insufficient bodata collected)
 
*open: all biodata collected and zone accessible
 
* unlocked: biodata collected but zone not yet accessible
 
* cleared: zone has been cleared
 
 
 
==Quests from the Elemental Planes==
 
===Spring Break Beach===
 
The Elemental Plane of Sleaze
 
=====questESlMushStash=====
 
Jimmy's Quest to collect receipts from the Fun-Guy Mansion.
 
=====questESlAudit=====
 
Taco Dan's Quest to collect receipts from the Fun-Guy Mansion.
 
=====questESlBacteria=====
 
Broden's Quest to collect bacteria from the Fun-Guy Mansion.
 
=====questESlCheeseburger=====
 
Jimmy's Quest to collect ingredients from the Sloppy Seconds Diner.
 
=====questESlSprinkles=====
 
Taco Dan's Quest to collect ingredients from the Sloppy Seconds Diner.
 
=====questESlCocktail=====
 
Broden's Quest to collect sprinkles from the Sloppy Seconds Diner.
 
=====questESlSalt=====
 
Jimmy's Quest to collect salt from the Sunken Yacht.
 
=====questESlFish=====
 
Taco Dan's Quest to collect fish meat from the Sunken Yacht.
 
=====questESlDebt=====
 
Broden's Quest to collect broupons from the Sunken Yacht.
 
 
 
===Conspiracy Island===
 
The Elemental Plane of Spooky
 
=====questESpOutOfOrder=====
 
Deep Dark Jungle - Out of Order
 
=====questESpJunglePun=====
 
Deep Dark Jungle - Pungle in the Jungle
 
=====questESpSmokes=====
 
Deep Dark Jungle - Everyone's Running Out of Smokes
 
=====questESpClipper=====
 
Mansion of Dr. Weirdeaux - The Big Clipper
 
=====questESpSerum=====
 
Mansion of Dr. Weirdeaux - Serum Sortie
 
=====questESpEVE=====
 
Secret Government Laboratory - Choking on the Rind
 
=====questESpFakeMedium=====
 
Secret Government Laboratory - Fake Medium at Large
 
=====questESpGore=====
 
Secret Government Laboratory - Gore Tipper
 

Latest revision as of 23:53, 24 January 2021

Function Syntax

boolean can_faxbot(monster mob )

  • mob is the monster for which to check.

Checks to see if mob can be faxed by any of the faxbots known to KoLmafia. This does not check if the faxbot(s) are online.[1]

Code Samples

This will acquire a copy of a scary pirate if you can get one.

if( get_property("_photocopyUsed")=="false" && can_faxbot($monster[scary pirate]) )
 faxbot($monster[scary pirate]);

See Also

faxbot() | is_online()


References