To boolean

From Kolmafia
Revision as of 13:51, 30 April 2010 by imported>Zarqon
Jump to navigation Jump to search
needs(code_samples);

Function Syntax

boolean to_boolean( any anything)

  • anything is any basic data type that KoLmafia uses

Datatype behaviour: This function converts the supplied datatype to a boolean value. For strings, this means that it will return false for everything except "true". This is case-sensitive -- "TRUE" will still return false. For all other datatypes, it returns to_int(anything) != 0. More details:

  • As indicated, integers return true for anything except 0, even negative values.
  • floats return true for anything except -1.0 to 1.0 (not inclusive). This is because to_int(float) truncates the float.
  • locations and monsters all return false. For these datatypes, to_int() always returns 0.
  • elements, slots, and classes return true for everything except the value that converts to 0. This is [none] for elements, [hat] for slots, and [seal clubber] for classes.
  • Other mafia datatypes (effects, familiars, items, stats and skills) all return true. Note that for these datatypes, to_int([none]) returns -1.

    See Also

to_int()