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.

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()

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_CoolDownTimer_timeout():
    _can_shoot = true

Methods

bool

bool ( ) constructor

bool

bool ( bool from ) constructor

bool

bool ( float from ) constructor

bool

bool ( int from ) constructor

bool

operator != ( ) operator

bool

operator != ( bool right ) operator

bool

operator < ( bool right ) operator

bool

operator == ( ) operator

bool

operator == ( bool right ) operator

bool

operator > ( bool right ) operator

Method Descriptions

  • bool bool ( ) constructor

Constructs a default-initialized bool set to false.


Constructs a bool as a copy of the given bool.


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 ) constructor

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


  • bool operator != ( ) operator


  • bool operator != ( bool right ) operator

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


  • bool operator < ( bool right ) operator

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


  • bool operator == ( ) operator


  • bool operator == ( bool right ) operator

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


  • bool operator > ( bool right ) operator

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