Difference between revisions of "Hermit"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
m (typo)
imported>Malurth
m (No such thing as adventuring in the sewer anymore.)
Line 17: Line 17:
 
}}|
 
}}|
  
function_description=Attempts to acquire {{pspan|qty}} amount of item {{pspan|get}}. Will adventure in the sewer, buying chewing gum on a string as needed. Reports success based on whether it acquired as many of item {{pspan|get}} as possible. If {{pspan|get}} is not a hermit item, this function will return true. This function will fail to return any value and abort completely if unable to buy the required chewing gum on a string.</p>
+
function_description=Attempts to acquire {{pspan|qty}} amount of item {{pspan|get}}. Will buy and use chewing gum on a string as needed. Reports success based on whether it acquired as many of item {{pspan|get}} as possible. If {{pspan|get}} is not a hermit item, this function will return true. This function will fail to return any value and abort completely if unable to buy the required chewing gum on a string.</p>
 
<p>If the hermit does not have enough ten-leaf clovers in stock to satisfy a request, it will acquire as many as possible and then return false.|
 
<p>If the hermit does not have enough ten-leaf clovers in stock to satisfy a request, it will acquire as many as possible and then return false.|
  

Revision as of 10:01, 1 February 2011

needs(code_samples);

Function Syntax

boolean hermit(int qty ,item get )

  • qty is the quantity to acquire
  • get is the hermit item to trade for

Attempts to acquire qty amount of item get. Will buy and use chewing gum on a string as needed. Reports success based on whether it acquired as many of item get as possible. If get is not a hermit item, this function will return true. This function will fail to return any value and abort completely if unable to buy the required chewing gum on a string.

If the hermit does not have enough ten-leaf clovers in stock to satisfy a request, it will acquire as many as possible and then return false.

CLI Equivalent

The CLI command "hermit" with the parameter "item" works similarly.