To boolean: Difference between revisions
Jump to navigation
Jump to search
Does not work on slots, elements, items, etc. |
Updated |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 11: | Line 11: | ||
return_type={{#var:return_type}}| | return_type={{#var:return_type}}| | ||
return_also={{#var:return_also}}| | return_also={{#var:return_also}}| | ||
parameter1= | parameter1={{Param|int|convert}}| | ||
p1desc={{Pspan| | }}| | ||
function2={{Function| | |||
name={{#var:name}}| | |||
aggregate={{#var:aggregate}}| | |||
return_type={{#var:return_type}}| | |||
return_also={{#var:return_also}}| | |||
parameter1={{Param|float|convert}}| | |||
}}| | |||
function3={{Function| | |||
name={{#var:name}}| | |||
aggregate={{#var:aggregate}}| | |||
return_type={{#var:return_type}}| | |||
return_also={{#var:return_also}}| | |||
parameter1={{Param|string|convert}}| | |||
p1desc={{Pspan|convert}} is the int, float, or string to convert| | |||
}}| | }}| | ||
| Line 20: | Line 36: | ||
* 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. | ||
Note: The string is case insensitive.| | |||
code1={{CodeSample| | |||
title=Code Samples| | |||
description=Following example shows basic to_boolean operations.| | |||
code= | |||
<syntaxhighlight> | |||
string first, second, third, fourth; | |||
int fifth, sixth; | |||
first = "random stuff"; | |||
second = "true"; | |||
third = "tRuE"; | |||
fourth = "TRUE"; | |||
fifth = 5; | |||
sixth = 0; | |||
print(first+" gives "+to_boolean(first)+".", "blue"); | |||
print(second+" gives "+to_boolean(second)+".", "blue"); | |||
print(third+" gives "+to_boolean(third)+".", "blue"); | |||
print(fourth+" gives "+to_boolean(fourth)+".", "blue"); | |||
print(fifth+" gives "+to_boolean(fifth)+".", "blue"); | |||
print(sixth+" gives "+to_boolean(sixth)+".", "blue"); | |||
</syntaxhighlight>| | |||
moreinfo=It gives the following output. | |||
<pre> | |||
random stuff gives false. | |||
true gives true. | |||
tRuE gives true. | |||
TRUE gives true. | |||
5 gives true. | |||
0 gives false. | |||
</pre> | |||
}}| | |||
see_also={{SeeAlso|to_int}} | see_also={{SeeAlso|to_int}} | ||
Latest revision as of 14:18, 26 January 2015
Function Syntax
boolean to_boolean(int convert )
boolean to_boolean(float convert )
boolean to_boolean(string convert )
- convert is the int, float, or string to convert
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". 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.
Note: The string is case insensitive.
Code Samples
Following example shows basic to_boolean operations.
string first, second, third, fourth;
int fifth, sixth;
first = "random stuff";
second = "true";
third = "tRuE";
fourth = "TRUE";
fifth = 5;
sixth = 0;
print(first+" gives "+to_boolean(first)+".", "blue");
print(second+" gives "+to_boolean(second)+".", "blue");
print(third+" gives "+to_boolean(third)+".", "blue");
print(fourth+" gives "+to_boolean(fourth)+".", "blue");
print(fifth+" gives "+to_boolean(fifth)+".", "blue");
print(sixth+" gives "+to_boolean(sixth)+".", "blue");It gives the following output.
random stuff gives false. true gives true. tRuE gives true. TRUE gives true. 5 gives true. 0 gives false.