bool
A built-in boolean type.
Description
The bool is a built-in Variant type that may only store one of two values: true or false. You can imagine it as a switch that can be either turned on or off, or as a binary digit that can either be 1 or 0.
Booleans can be directly used in if, and other conditional statements:
All comparison operators return booleans (==, >, <=, etc.). As such, it is not necessary to compare booleans themselves. You do not need to add == true or == false.
Booleans can be combined with the logical operators and, or, not to create complex conditions:
Note: In modern programming languages, logical operators are evaluated in order. All remaining conditions are skipped if their result would have no effect on the final value. This concept is known as short-circuit evaluation and can be useful to avoid evaluating expensive conditions in some performance-critical cases.
Note: By convention, built-in methods and properties that return booleans are usually defined as yes-no questions, single adjectives, or similar (String.is_empty(), Node.can_process(), Camera2D.enabled, etc.).
Constructors
bool() |
|
Operators
operator !=(right: bool) |
|
operator <(right: bool) |
|
operator ==(right: bool) |
|
operator >(right: bool) |
Constructor Descriptions
Constructs a bool set to false.
Constructs a bool as a copy of the given bool.
Casts a float value to a bool. Returns false if from is equal to 0.0 (including -0.0), and true for all other values (including @GDScript.INF and @GDScript.NAN).
Casts an int value to a bool. Returns false if from is equal to 0, and true for all other values.
Operator Descriptions
bool operator !=(right: bool) 🔗
Returns true if one bool is true and the other bool is false. Equivalent to logical XOR (NEQ).
bool operator <(right: bool) 🔗
Returns true if the left bool is false and right is true.
bool operator ==(right: bool) 🔗
Returns true if both bools are true, or if both bools are false. Equivalent to logical XNOR (EQ).
bool operator >(right: bool) 🔗
Returns true if the left bool is true and right is false.