Difference between revisions of "To boolean"
Jump to navigation
Jump to search
imported>StDoodle m |
imported>Zarqon (Added a good bit more information. Entirely removed RFI. Recommend See also: to_int(), but don't kow how to add.) |
||
| Line 13: | Line 13: | ||
return_also={{#var:return_also}}| | return_also={{#var:return_also}}| | ||
parameter1= '''any''' {{pspan|anything}}| | parameter1= '''any''' {{pspan|anything}}| | ||
| − | p1desc={{Pspan|anything}} is any data type that KoLmafia uses| | + | p1desc={{Pspan|anything}} is any basic data type that KoLmafia uses| |
}}| | }}| | ||
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: | |
| − | * integers return true for anything except 0. | + | <p> |
| − | * floats return true for anything except -1.0 to 1.0 (not inclusive). | + | * As indicated, integers return true for anything except 0, even negative values. |
| − | * locations | + | * 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.| | |
| − | * | ||
| − | |||
| − | |||
| − | * stats return true. | ||
| − | |||
| − | |||
needscode=yes| | needscode=yes| | ||
}} | }} | ||
| − | |||
Revision as of 06:18, 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.