Difference between revisions of "My inebriety"

From Kolmafia
Jump to navigation Jump to search
imported>Metraxis
(New Page)
 
imported>Bale
m
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[int]] [[my_inebriety()]]
+
{{
 +
#vardefine:name|my_inebriety}}{{
 +
#vardefine:return_type|int}}{{
  
This function returns the logged-in character's current level of drunkenness as an [[int]].  This information, combined with the character's [[inebriety_limit()]], is vital for any script which intends to drink for the character, but without overdrinking.
+
FunctionPage|
 +
name={{#var:name}}|
  
An example:
+
function1={{Function|
<code>
+
name={{#var:name}}|
if([[inebriety_limit()]] - [[my_inebriety()]] < 5) {
+
aggregate={{#var:aggregate}}|
  [[int]] advisable = [[inebriety_limit()]] - [[my_inebriety()]] - 1;
+
return_type={{#var:return_type}}|
  [[drink]](advisable,$[[item]][Ram's Face Lager]);
+
return_also={{#var:return_also}}|
}
+
}}|
</code>
+
 
 +
function_description=Returns the logged-in character's current level of drunkenness.|
 +
 
 +
code1={{CodeSample|
 +
title=Code Samples|
 +
description=Checking to see if your character is drunk:|
 +
code=
 +
<syntaxhighlight>
 +
if (my_inebriety() > inebriety_limit()) abort("You are too plastered to continue.");
 +
</syntaxhighlight>}}|
 +
 
 +
see_also={{SeeAlso|inebriety_limit}}|
 +
special=When not logged in, this function returns 0.
 +
}}
 +
 
 +
[[Category:Your Character]]

Latest revision as of 21:40, 21 May 2010

Function Syntax

int my_inebriety()

Returns the logged-in character's current level of drunkenness.

Code Samples

Checking to see if your character is drunk:

if (my_inebriety() > inebriety_limit()) abort("You are too plastered to continue.");

See Also

inebriety_limit()

Special

When not logged in, this function returns 0.