Attention
You are reading the latest
(unstable) version of this documentation, which may document features not available
or compatible with Godot 3.x.
Checking the stable version of the documentation...
Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
float¶
Float built-in type.
Description¶
The float built-in type is a 64-bit double-precision floating-point number, equivalent to double in C++. This type has 14 reliable decimal digits of precision. The float type can be stored in Variant, which is the generic type used by the engine. The maximum value of float is approximately 1.79769e308, and the minimum is approximately -1.79769e308.
Many methods and properties in the engine use 32-bit single-precision floating-point numbers instead, equivalent to float in C++, which have 6 reliable decimal digits of precision. For data structures such as Vector2 and Vector3, Godot uses 32-bit floating-point numbers by default, but it can be changed to use 64-bit doubles if Godot is compiled with the precision=double option.
Math done using the float type is not guaranteed to be exact or deterministic, and will often result in small errors. You should usually use the @GlobalScope.is_equal_approx and @GlobalScope.is_zero_approx methods instead of == to compare float values for equality.
Tutorials¶
Constructors¶
float ( ) |
|
Operators¶
operator != ( float right ) |
|
operator != ( int right ) |
|
operator * ( Color right ) |
|
operator * ( Quaternion right ) |
|
operator * ( Vector2 right ) |
|
operator * ( Vector2i right ) |
|
operator * ( Vector3 right ) |
|
operator * ( Vector3i right ) |
|
operator * ( Vector4 right ) |
|
operator * ( Vector4i right ) |
|
operator * ( float right ) |
|
operator * ( int right ) |
|
operator ** ( float right ) |
|
operator ** ( int right ) |
|
operator + ( float right ) |
|
operator + ( int right ) |
|
operator - ( float right ) |
|
operator - ( int right ) |
|
operator / ( float right ) |
|
operator / ( int right ) |
|
operator < ( float right ) |
|
operator < ( int right ) |
|
operator <= ( float right ) |
|
operator <= ( int right ) |
|
operator == ( float right ) |
|
operator == ( int right ) |
|
operator > ( float right ) |
|
operator > ( int right ) |
|
operator >= ( float right ) |
|
operator >= ( int right ) |
|
operator unary+ ( ) |
|
operator unary- ( ) |
Constructor Descriptions¶
float float ( )
Constructs a default-initialized float set to 0.0.
Constructs a float as a copy of the given float.
Converts a String to a float, following the same rules as String.to_float.
Cast a bool value to a floating-point value, float(true) will be equal to 1.0 and float(false) will be equal to 0.0.
Cast an int value to a floating-point value, float(1) will be equal to 1.0.
Operator Descriptions¶
bool operator != ( float right )
Returns true if two floats are different from each other.
bool operator != ( int right )
Returns true if the integer has different value than the float.
Color operator * ( Color right )
Multiplies each component of the Color by the given float.
print(1.5 * Color(0.5, 0.5, 0.5)) # Color(0.75, 0.75, 0.75)
Quaternion operator * ( Quaternion right )
Multiplies each component of the Quaternion by the given float. This operation is not meaningful on its own, but it can be used as a part of a larger expression.
Vector2 operator * ( Vector2 right )
Multiplies each component of the Vector2 by the given float.
print(2.5 * Vector2(1, 3)) # Prints "(2.5, 7.5)"
Vector2 operator * ( Vector2i right )
Multiplies each component of the Vector2i by the given float. Returns a Vector2.
print(0.9 * Vector2i(10, 15)) # Prints "(9, 13.5)"
Vector3 operator * ( Vector3 right )
Multiplies each component of the Vector3 by the given float.
Vector3 operator * ( Vector3i right )
Multiplies each component of the Vector3i by the given float. Returns a Vector3.
print(0.9 * Vector3i(10, 15, 20)) # Prints "(9, 13.5, 18)"
Vector4 operator * ( Vector4 right )
Multiplies each component of the Vector4 by the given float.
Vector4 operator * ( Vector4i right )
Multiplies each component of the Vector4i by the given float. Returns a Vector4.
print(0.9 * Vector4i(10, 15, 20, -10)) # Prints "(9, 13.5, 18, -9)"
float operator * ( float right )
Multiplies two floats.
float operator * ( int right )
Multiplies a float and an int. The result is a float.
float operator ** ( float right )
Raises a float to a power of a float.
print(39.0625**0.25) # 2.5
float operator ** ( int right )
Raises a float to a power of an int. The result is a float.
print(0.9**3) # 0.729
float operator + ( float right )
Adds two floats.
float operator + ( int right )
Adds a float and an int. The result is a float.
float operator - ( float right )
Subtracts a float from a float.
float operator - ( int right )
Subtracts an int from a float. The result is a float.
float operator / ( float right )
Divides two floats.
float operator / ( int right )
Divides a float by an int. The result is a float.
bool operator < ( float right )
Returns true if the left float is less than the right one.
Returns true if this float is less than the given int.
bool operator <= ( float right )
Returns true if the left float is less than or equal to the right one.
bool operator <= ( int right )
Returns true if this float is less than or equal to the given int.
bool operator == ( float right )
Returns true if both floats are exactly equal.
Note: Due to floating-point precision errors, consider using @GlobalScope.is_equal_approx or @GlobalScope.is_zero_approx instead, which are more reliable.
bool operator == ( int right )
Returns true if the float and the given int are equal.
bool operator > ( float right )
Returns true if the left float is greater than the right one.
Returns true if this float is greater than the given int.
bool operator >= ( float right )
Returns true if the left float is greater than or equal to the right one.
bool operator >= ( int right )
Returns true if this float is greater than or equal to the given int.
float operator unary+ ( )
Returns the same value as if the + was not there. Unary + does nothing, but sometimes it can make your code more readable.
float operator unary- ( )
Returns the negative value of the float. If positive, turns the number negative. If negative, turns the number positive. With floats, the number zero can be either positive or negative.