Drink: Difference between revisions
Rewrite page to use Template:Function2. Also add info on clear_booze_helper(). |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
|function1.description=Attempts to drink the {{pspan|booze}} item(s). | |function1.description=Attempts to drink the {{pspan|booze}} item(s). | ||
|function1.param1=booze | |function1.param1=booze | ||
|function1.param1.type=item | |||
|function1.param1.description=Item to drink | |function1.param1.description=Item to drink | ||
|function1.param2=qty | |function1.param2=qty | ||
|function1.param2.type=int | |||
|function1.param2.description=Amount to drink | |function1.param2.description=Amount to drink | ||
|function1.param2.optional=yes | |function1.param2.optional=yes | ||
| Line 12: | Line 14: | ||
|function2.description=Attempts to drink {{pspan|qty}} of {{pspan|booze}}. | |function2.description=Attempts to drink {{pspan|qty}} of {{pspan|booze}}. | ||
|function2.param1=qty | |function2.param1=qty | ||
|function2.param1.type=int | |||
|function2.param1.description=Amount to drink | |function2.param1.description=Amount to drink | ||
|function2.param2=booze | |function2.param2=booze | ||
|function2.param2.type=item | |||
|function2.param2.description=Item to drink | |function2.param2.description=Item to drink | ||
|description=<p>Attempts to drink {{pspan|qty}} amount of the {{pspan|booze}} item. Returns <code>true</code> for drinkable items and <code>false</code> for items that are not. (The return value does not reflect whether or not the items were actually consumed.)</p> | |description=<p>Attempts to drink {{pspan|qty}} amount of the {{pspan|booze}} item. Returns <code>true</code> for drinkable items and <code>false</code> for items that are not. (The return value does not reflect whether or not the items were actually consumed.)</p> | ||
| Line 39: | Line 43: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}} | {{!}}} | ||
}} | |||
|cli_equiv=The CLI command <code>drink</code> works similarly. | |cli_equiv=The CLI command <code>drink</code> works similarly. | ||
|see_also={{SeeAlso/Booze Management}} | |||
}} | }} | ||
</onlyinclude> | </onlyinclude> | ||
[[Category:Item Management]] | [[Category:Item Management]] | ||
Latest revision as of 14:33, 13 July 2021
Function Syntax
boolean drink( item booze, int? qty = 1 )
- Attempts to drink the booze item(s).
- booze: Item to drink
- qty: Amount to drink
boolean drink( int qty, item booze )
- Attempts to drink qty of booze.
- qty: Amount to drink
- booze: Item to drink
Attempts to drink qty amount of the booze item. 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.)
You can also "drink" drink helper items (e.g. divine champagne flute) to queue them before drinking the actual booze item. Drink helpers can be identified with item_type(), which returns "drink helper" for such items. To cancel all queued drink helpers, call clear_booze_helper().
If this command will cause you to overdrink, KoLmafia will show a warning dialog. Using this command without Ode to Booze active will also show a warning, if you have the skill and the MP required to cast it.
Code Sample
Drinks as many tangaritas as possible without getting drunk.
| ASH | JavaScript |
|---|---|
int amount = floor((inebriety_limit() - my_inebriety()) / 4);
drink(amount, $item[tangarita]);
|
const { drink, inebrietyLimit, myInebriety } = require("kolmafia");
const amount = Math.floor((inebrietyLimit() - myInebriety()) / 4);
drink(amount, Item.get('tangarita'));
|
CLI Equivalent
The CLI command drink works similarly.