int

Integer built-in type.

Description

Signed 64-bit integer type.

It can take values in the interval [-2^63, 2^63 - 1], i.e. [-9223372036854775808, 9223372036854775807]. Exceeding those bounds will wrap around.

int is a Variant type, and will thus be used when assigning an integer value to a Variant. It can also be enforced with the : int type hint.

var my_variant = 0 # int, value 0.
my_variant += 4.2 # float, value 4.2.
var my_int: int = 1 # int, value 1.
my_int = 4.2 # int, value 4, the right value is implicitly cast to int.
my_int = int("6.7") # int, value 6, the String is explicitly cast with int.
var max_int = 9223372036854775807
print(max_int) # 9223372036854775807, OK.
max_int += 1
print(max_int) # -9223372036854775808, we overflowed and wrapped around.

Methods

int

int ( ) constructor

int

int ( int from ) constructor

int

int ( bool from ) constructor

int

int ( float from ) constructor

bool

operator != ( ) operator

bool

operator != ( float right ) operator

bool

operator != ( int right ) operator

int

operator % ( int right ) operator

int

operator & ( int right ) operator

int

operator * ( int right ) operator

float

operator * ( float right ) operator

Vector2

operator * ( Vector2 right ) operator

Vector2i

operator * ( Vector2i right ) operator

Vector3

operator * ( Vector3 right ) operator

Vector3i

operator * ( Vector3i right ) operator

Quaternion

operator * ( Quaternion right ) operator

Color

operator * ( Color right ) operator

int

operator + ( int right ) operator

float

operator + ( float right ) operator

float

operator - ( float right ) operator

int

operator - ( int right ) operator

float

operator / ( float right ) operator

int

operator / ( int right ) operator

bool

operator < ( float right ) operator

bool

operator < ( int right ) operator

int

operator << ( int right ) operator

bool

operator <= ( float right ) operator

bool

operator <= ( int right ) operator

bool

operator == ( ) operator

bool

operator == ( float right ) operator

bool

operator == ( int right ) operator

bool

operator > ( float right ) operator

bool

operator > ( int right ) operator

bool

operator >= ( float right ) operator

bool

operator >= ( int right ) operator

int

operator >> ( int right ) operator

int

operator ^ ( int right ) operator

int

operator unary+ ( ) operator

int

operator unary- ( ) operator

int

operator | ( int right ) operator

int

operator ~ ( ) operator

Method Descriptions

  • int int ( ) constructor

Constructs a default-initialized int set to 0.


  • int int ( int from ) constructor

Constructs an int as a copy of the given int.


  • int int ( bool from ) constructor

Cast a bool value to an integer value, int(true) will be equals to 1 and int(false) will be equals to 0.


Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds from towards zero), so for example int(2.7) will be equals to 2, int(0.1) will be equals to 0 and int(-2.7) will be equals to -2. This operation is also called truncation.


  • bool operator != ( ) operator


Returns true if operands are different from each other.


  • bool operator != ( int right ) operator

Returns true if operands are different from each other.


  • int operator % ( int right ) operator

Returns the result of the modulo operator for two integers, i.e. the remainder after dividing both numbers.

print(5 % 2) # 1
print(12 % 4) # 0
print(12 % 2) # 2

  • int operator & ( int right ) operator

Returns the result of bitwise AND operation for two integers.

print(3 & 1) # 1
print(11 & 3) # 3

It's useful to retrieve binary flags from a variable.

var flags = 5
# Do something if the first bit is enabled.
if flags & 1:
    do_stuff()

  • int operator * ( int right ) operator

Multiplies two ints.


Multiplies an int and a float. The result is a float.


Multiplies each component of the vector by the given integer.

print(2 * Vector2(1, 1)) # Vector2(2, 2)

Multiplies each component of the integer vector by the given integer.


Multiplies each component of the vector by the given integer.


Multiplies each component of the integer vector by the given integer.


Multiplies each component of the quaternion by the given integer.


Multiplies each component of the color by the given integer.

print(2 * Color(0.5, 0.5, 0.5)) # Color(1, 1, 1)

  • int operator + ( int right ) operator

Adds two integers.


Adds an int to a float. The result is a float.


Subtracts a float from an int. The result is a float.


  • int operator - ( int right ) operator

Subtracts two integers.


Divides an int by a float. The result is a float.

print(10 / 3.0) # 3.333...

  • int operator / ( int right ) operator

Divides two integers. The decimal part of the result is discarded (truncated).

print(10 / 2) # 5
print(10 / 3) # 3

Returns true if this int is less than the given float.


  • bool operator < ( int right ) operator

Returns true the left integer is less than the right one.


  • int operator << ( int right ) operator

Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2.

print(10 << 1) # 20
print(10 << 4) # 160

Returns true if this int is less than or equal to the given float.


  • bool operator <= ( int right ) operator

Returns true the left integer is less than or equal to the right one.


  • bool operator == ( ) operator


Returns true if the integer is equal to the given float.


  • bool operator == ( int right ) operator

Returns true if both integers are equal.


Returns true if this int is greater than the given float.


  • bool operator > ( int right ) operator

Returns true the left integer is greater than the right one.


Returns true if this int is greater than or equal to the given float.


  • bool operator >= ( int right ) operator

Returns true the left integer is greater than or equal to the right one.


  • int operator >> ( int right ) operator

Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2.

print(10 >> 1) # 5
print(10 >> 2) # 2

  • int operator ^ ( int right ) operator

Returns the result of bitwise XOR operation for two integers.

print(5 ^ 1) # 4
print(4 ^ 7) # 3

  • int operator unary+ ( ) operator

Returns the same value as if the + was not there. Unary + does nothing, but sometimes it can make your code more readable.


  • int operator unary- ( ) operator

Returns the negated value of the int. If positive, turns the number negative. If negative, turns the number positive. If zero, does nothing.


  • int operator | ( int right ) operator

Returns the result of bitwise OR operation for two integers.

print(2 | 4) # 6
print(1 | 3) # 3

It's useful to store binary flags in a variable.

var flags = 0
# Turn first and third bit on.
flags |= 1
flags |= 4

  • int operator ~ ( ) operator

Returns the result of bitwise NOT operation for the integer. It's effectively equal to -int + 1.

print(~4) # -3
print(~7) # -6