Extract items: Difference between revisions
imported>Heeheehee m Added restriction (bug notice). |
imported>Bale This should be the only problem. RFI removed. |
||
| Line 17: | Line 17: | ||
}}| | }}| | ||
function_description=This function searches your supplied {{pspan|text}}, searching for either the phrase "You acquire an item: <nowiki><b>THING</b></nowiki>" or "You acquire <nowiki><b># THINGS</b></nowiki>" and returns a map keyed by items ("THING"), with the quantity of each item as the value. Note that the phrases to search are | function_description=This function searches your supplied {{pspan|text}}, searching for either the phrase "You acquire an item: <nowiki><b>THING</b></nowiki>" or "You acquire <nowiki><b># THINGS</b></nowiki>" 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).</p> | ||
<p>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: <nowiki><b>Mr. Accessory<b></nowiki>" will cost you. For secure sales you'll need to use [[contains_text|contains_text()]] and a harder to forge string.</p> | |||
<p>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.| | |||
needscode=yes| | needscode=yes| | ||
| Line 24: | Line 26: | ||
special=This function returns an empty map if it does not find any matches. | special=This function returns an empty map if it does not find any matches. | ||
}} | }} | ||
Revision as of 21:41, 29 April 2010
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.
See Also
Special
This function returns an empty map if it does not find any matches.