Difference between revisions of "Hermit"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>Bale
(partially answered RFI)
Line 19: Line 19:
 
}}|
 
}}|
  
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.|
+
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>
 +
<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.|
  
 
needscode=yes|
 
needscode=yes|
Line 25: Line 26:
 
cli_equiv=The CLI command "hermit" with the parameter "item" works similarly.|
 
cli_equiv=The CLI command "hermit" with the parameter "item" works similarly.|
 
}}
 
}}
{{RFI|What does this function return if you attempt to grab more clovers than available (true if it gets as many as possible, or false)?|What's the order of operations for chewing gum check vs. able to adventure check?|What does out of adventures return?}}
+
{{RFI|What's the order of operations for chewing gum check vs. able to adventure check?|What does out of adventures return?}}

Revision as of 10:27, 22 March 2010

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 adventure in the sewer, buying 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.


Attention KoLmafia Experts!

We need your help; some details of this function's operation are unknown or unclear.

The following specific questions have been raised:

  • What's the order of operations for chewing gum check vs. able to adventure check?
  • What does out of adventures return?