Overdrink: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
Convert to Template:Function2 format
Remove function1.description since it's redundant with function2.description
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
|name=overdrink
|name=overdrink
|function1.return_type=boolean
|function1.return_type=boolean
|function1.description=Attempts to drink a given number of item(s), suppressing overdrinking warnings.
|function1.description=
|function1.param1=qty
|function1.param1=qty
|function1.param1.type=int
|function1.param1.type=int
Line 21: Line 21:
|function2.param2.default=1
|function2.param2.default=1
|function2.param2.description=Quantity of item to drink
|function2.param2.description=Quantity of item to drink
|description=<p>Attempts to drink {{pspan|qty}} amount of item {{pspan|consume}}. Returns <code>true</code> on success, <code>false</code> on failure. (The return value does not reflect whether or not the items were actually consumed.)</p>
|description=<p>Attempts to drink {{pspan|qty}} amount of item {{pspan|consume}}. Returns <code>true</code> for drinkable items and <code>false</code> for others. (The return value does not reflect whether or not the items were actually consumed.)</p>


<p>Using this command, rather than {{f|drink}}, suppresses warning dialogs for overdrinking and drinking without Ode to Booze.</p>
<p>Using this command, rather than {{f|drink}}, suppresses warning dialogs for overdrinking and drinking without Ode to Booze.</p>
<p>The second form (item, quantity) was added in [https://kolmafia.us/threads/19548-add-method-chaining-variants-for-ash-functions-overdrink-retrieve_item-buy.24218/ r19548].</p>
|code1={{CodeSample
|code1={{CodeSample
   |title=Code Samples
   |title=Code Samples

Latest revision as of 14:21, 23 December 2020

Function Syntax

boolean overdrinkint qty, item consume )

  • qty: Quantity of item to drink
  • consume: Item to drink

boolean overdrinkitem consume, int? qty = 1 )

Attempts to drink a given number of item(s), suppressing overdrinking warnings.
  • consume: Item to drink
  • qty: Quantity of item to drink

Attempts to drink qty amount of item consume. Returns true for drinkable items and false for others. (The return value does not reflect whether or not the items were actually consumed.)

Using this command, rather than drink(), suppresses warning dialogs for overdrinking and drinking without Ode to Booze.

The second form (item, quantity) was added in r19548.

Code Samples

This will drink 1 Mae West without Ode without a warning if you are unable to get Ode.

if ( !have_skill( $skill[ The Ode to Booze ] ) && !can_interact() )
{
   // Make sure we are not over drinking with the Mea West
   if ( inebriety_limit() >= my_inebriety() + 4 ) {
      print( "You don't have Ode and can't get it, drinking Mae West anyways." );
      overdrink( 1, $item[ Mae West ] ); // Overdrink Prevents Ode Warning
   }
   else
   {
      print( "You do not have enough inebriety left to prevent overdrunkeness" );
   }
}
else
{
   print( "You should cast or acquire the Ode Buff before drinking." );
}

Beware: Since it suppresses the overdrink warning, it is wise to do checks to assure you don't accidentally overdrink when using it to prevent the Ode Warning.

CLI Equivalent

The CLI command "drink" works similarly.

See Also

can_drink() | drink() | inebriety_limit() | my_inebriety()