Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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:

var can_shoot = true
if can_shoot:
    launch_bullet()

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:

if bullets > 0 and not is_reloading():
    launch_bullet()

if bullets == 0 or is_reloading():
    play_clack_sound()

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

bool ( )

bool

bool ( bool from )

bool

bool ( float from )

bool

bool ( int from )

Operators

bool

operator != ( bool right )

bool

operator < ( bool right )

bool

operator == ( bool right )

bool

operator > ( bool right )


Constructor Descriptions

bool bool ( )

Constructs a bool set to false.


bool bool ( bool from )

Constructs a bool as a copy of the given bool.


bool bool ( float from )

Cast a float value to a boolean value. Returns false if from is equal to 0.0 (including -0.0), and true for all other values (including @GDScript.INF and @GDScript.NAN).


bool bool ( int from )

Cast an