Overdrink: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
mNo edit summary
imported>Eliteofdelete
Code Example
Line 19: Line 19:
function_description=Will attempt to drink {{pspan|qty}} amount of item {{pspan|consume}}. Returns true for drinkable items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using this command, rather than {{f|drink}}, suppresses warning dialogs for overdrinking and drinking without Ode to Booze.|
function_description=Will attempt to drink {{pspan|qty}} amount of item {{pspan|consume}}. Returns true for drinkable items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using this command, rather than {{f|drink}}, suppresses warning dialogs for overdrinking and drinking without Ode to Booze.|


needscode=yes|
code1={{CodeSample|
title=Code Samples|
description=This will drink Mae West without Ode without a warning if you are unable to get Ode.|
code=
<syntaxhighlight>
if (!have_skill($skill[The Ode to Booze]) && !can_interact()) {
  if (inebriety_limit() >= my_inebriety()+4) { //Make sure we are not over drinking with the Mea West
      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.");
</syntaxhighlight>|
moreinfo=
Checks to see if you have Ode and that you can't get it from a buff bot. Then it drinks it "silently" after making sure it won't overdrink off of it.
}}|


see_also={{SeeAlso|can_drink|drink|inebriety_limit|my_inebriety}}|
see_also={{SeeAlso|can_drink|drink|inebriety_limit|my_inebriety}}|

Revision as of 13:17, 2 January 2015

Function Syntax

boolean overdrink(int qty ,item consume )

  • qty is the quantity to drink
  • consume is the item to drink

Will attempt to drink qty amount of item consume. Returns true for drinkable items and false for items that are not. (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.

Code Samples

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

if (!have_skill($skill[The Ode to Booze]) && !can_interact()) {
   if (inebriety_limit() >= my_inebriety()+4) { //Make sure we are not over drinking with the Mea West
      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.");

Checks to see if you have Ode and that you can't get it from a buff bot. Then it drinks it "silently" after making sure it won't overdrink off of it.

CLI Equivalent

The CLI command "drink" works similarly.

See Also

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