Overdrink: Difference between revisions
Jump to navigation
Jump to search
imported>Eliteofdelete No edit summary |
Convert to Template:Function2 format |
||
Line 1: | Line 1: | ||
{{ | <onlyinclude>{{{{{format|Function2}}} | ||
|name=overdrink | |||
|function1.return_type=boolean | |||
|function1.description=Attempts to drink a given number of item(s), suppressing overdrinking warnings. | |||
|function1.param1=qty | |||
|function1.param1.type=int | |||
|function1.param1.description=Quantity of item to drink | |||
|function1.param2=consume | |||
|function1.param2.type=item | |||
|function1.param2.optional= | |||
|function1.param2.default= | |||
|function1.param2.description=Item to drink | |||
|function2.return_type=boolean | |||
|function2.description=Attempts to drink a given number of item(s), suppressing overdrinking warnings. | |||
|function2.param1=consume | |||
|function2.param1.type=item | |||
|function2.param1.description=Item to drink | |||
|function2.param2=qty | |||
|function2.param2.type=int | |||
|function2.param2.optional=yes | |||
|function2.param2.default=1 | |||
|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> | |||
<p>Using this command, rather than {{f|drink}}, suppresses warning dialogs for overdrinking and drinking without Ode to Booze.</p> | |||
|code1={{CodeSample | |||
|title=Code Samples | |||
|description=This will drink 1 Mae West without Ode without a warning if you are unable to get Ode. | |||
|code= | |||
<syntaxhighlight lang="d"> | |||
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" ); | |||
code1={{CodeSample| | |||
title=Code Samples| | |||
description=This will drink 1 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) { | |||
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 | |||
{ | |||
</syntaxhighlight>| | print( "You should cast or acquire the Ode Buff before drinking." ); | ||
moreinfo= | } | ||
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. | </syntaxhighlight> | ||
|moreinfo=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. | |||
}} | }} | ||
|see_also={{SeeAlso|can_drink|drink|inebriety_limit|my_inebriety}} | |||
|cli_equiv=The CLI command "drink" works similarly. | |||
}}</onlyinclude> | |||
[[Category:Item Management]] | [[Category:Item Management]] |
Revision as of 13:05, 23 December 2020
Function Syntax
boolean overdrink( int qty, item consume )
- Attempts to drink a given number of item(s), suppressing overdrinking warnings.
- qty: Quantity of item to drink
- consume: Item to drink
boolean overdrink( item 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
on success, false
on failure. (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 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.