extract_items()

From KoLMafia
Jump to: navigation, search

Function Syntax

int [item] extract_items(string text )

  • text is the string to search

This function searches your supplied text, searching for either the phrase "You acquire an item: <b>THING</b>" or "You acquire <b># THINGS</b>" and returns a map keyed by items ("THING"), with the quantity of each item as the value. Note that the phrases to search are case-sensitive, so it will not match on "You Acquire 10 broken skulls". This function can be used for parsing item acquisition from combat and kmails (though only the system messages are recommended from the latter, as the message text of a kmail can be set in a non-standard way).

If a kmail properly contains the text for item acquisition, this function will believe that the item was acquired. Consequently it should not be relied on in a case where a message containing text such as "You acquire an item: <b>Mr. Accessory<b>" will cost you. For secure sales you'll need to use contains_text() and a harder to forge string.

Note that this function cannot identify items affected by the sword behind inappropriate prepositions (acquired via pickpocketing, for instance). This has been reported as a bug and is subject to change.

Code Samples

Adventures once in the Castle of the Sky Top Floor and prints out which items were acquired from the fight.

int[item] items;
buffer fight = visit_url(to_url($location[The Castle in the Clouds in the Sky (Top Floor)]));
repeat {
   if (contains_text(fight, "choice.php")) { //Check to see if in a choice adventure
      cli_execute("choice-goal"); //Clear the choice adventure
      fight = visit_url(to_url($location[The Castle in the Clouds in the Sky (Top Floor)])); 
   }
} until (!contains_text(fight, "choice.php"));
fight = run_combat();
if (have_effect($effect[beaten up]) == 0) {
   items = extract_items(fight);
   print("You acquired the following items:", "green");
   foreach it, number in items 
      print(""+number+", "+it, "blue");
}
else print("You lost the fight :(", "red");
Does not work with the adventure() function unless it calls a consult script. You must use a visit_url() or a consult script.

See Also

Special

This function returns an empty map if it does not find any matches.