Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
float¶
A built-in type for floating point numbers.
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 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 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.
Note: @GDScript.NAN doesn't behave the same as other numbers. Therefore, the results from this operator may not be accurate if NaNs are included.
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, including the alpha, by the given float.
print(1.5 * Color(0.5, 0.5, 0.5)) # Prints "(0.75, 0.75, 0.75, 1.5)"
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.