Difference between revisions of "To boolean"
Jump to navigation
Jump to search
imported>Zarqon (Added a good bit more information. Entirely removed RFI. Recommend See also: to_int(), but don't kow how to add.) |
imported>Zarqon m |
||
| Line 18: | Line 18: | ||
function_description=Datatype behaviour: | function_description=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 true unless to_int(anything) == 0. More details: | 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 true unless to_int(anything) == 0. More details: | ||
| − | + | ||
* As indicated, integers return true for anything except 0, even negative values. | * 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. | * floats return true for anything except -1.0 to 1.0 (not inclusive). This is because to_int(float) truncates the float. | ||
Revision as of 06:19, 17 April 2010
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 true unless 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.