Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

bool¶

Boolean built-in type.

Description¶

Boolean is a built-in type. There are two boolean values: true and false. You can think of it as a switch with on or off (1 or 0) setting. Booleans are used in programming for logic in condition statements, like if statements.

Booleans can be directly used in if statements. The code below demonstrates this on the if can_shoot: line. You don't need to use == true, you only need if can_shoot:. Similarly, use if not can_shoot: rather than == false.

var _can_shoot = true

func shoot():
    if _can_shoot:
        pass # Perform shooting actions here.

private bool _canShoot = true;

public void Shoot()
{
    if (_canShoot)
    {
        // Perform shooting actions here.
    }
}

The following code will only create a bullet if both conditions are met: action "shoot" is pressed and if can_shoot is true.

Note: Input.is_action_pressed("shoot") is also a boolean that is true when "shoot" is pressed and false when "shoot" isn't pressed.

var _can_shoot = true

func shoot():
    if _can_shoot and Input.is_action_pressed("shoot"):
        create_bullet()

private bool _canShoot = true;

public void Shoot()
{
    if (_canShoot && Input.IsActionPressed("shoot"))
    {
        CreateBullet();
    }
}

The following code will set can_shoot to false and start a timer. This will prevent player from shooting until the timer runs out. Next can_shoot will be set to true again allowing player to shoot once again.

var _can_shoot = true
@onready var _cool_down = $CoolDownTimer

func shoot():
    if _can_shoot and Input.is_action_pressed("shoot"):
        create_bullet()
        _can_shoot = false
        _cool_down.start()

func _on_cool_down_timer_timeout():
    _can_shoot = true

private bool _canShoot = true;
private Timer _coolDown;

public override void _Ready()
{
    _coolDown = GetNode<Timer>("CoolDownTimer");
}

public void Shoot()
{
    if (_canShoot && Input.IsActionPressed("shoot"))
    {
        CreateBullet();
        _canShoot = false;
        _coolDown.Start();
    }
}

public void OnCoolDownTimerTimeout()
{
    _canShoot = true;
}

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 default-initialized 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, this method will return false if 0.0 is passed in, and true for all other floats.

bool bool ( int from )

Cast an int value to a boolean value, this method will return false if 0 is passed in, and true for all other ints.

Operator Descriptions¶

bool operator != ( bool right )

Returns true if two bools are different, i.e. one is true and the other is false.

bool operator < ( bool right )

Returns true if the left operand is false and the right operand is true.

bool operator == ( bool right )

Returns true if two bools are equal, i.e. both are true or both are false.

bool operator > ( bool right )

Returns true if the left operand is true and the right operand is false.