float

A built-in type for floating-point numbers.

描述

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.

构造函数
floatfloat ( )
floatfloat ( from: float )
floatfloat ( from: String )
floatfloat ( from: bool )
floatfloat ( from: int )

运算符
booloperator != ( right: float )
booloperator != ( right: int )
Coloroperator * ( right: Color )
Quaternionoperator * ( right: Quaternion )
Vector2operator * ( right: Vector2 )
Vector2operator * ( right: Vector2i )
Vector3operator * ( right: Vector3 )
Vector3operator * ( right: Vector3i )
Vector4operator * ( right: Vector4 )
Vector4operator * ( right: Vector4i )
floatoperator * ( right: float )
floatoperator * ( right: int )
floatoperator ** ( right: float )
floatoperator ** ( right: int )
floatoperator + ( right: float )
floatoperator + ( right: int )
floatoperator - ( right: float )
floatoperator - ( right: int )
floatoperator / ( right: float )
floatoperator / ( right: int )
booloperator < ( right: float )
booloperator < ( right: int )
booloperator <= ( right: float )
booloperator <= ( right: int )
booloperator == ( right: float )
booloperator == ( right: int )
booloperator > ( right: float )
booloperator > ( right: int )
booloperator >= ( right: float )
booloperator >= ( right: int )
floatoperator unary+ ( )
floatoperator unary- ( )

构造函数说明

float float ( )

Constructs a default-initialized float set to 0.0.

float float ( from: float )

Constructs a float as a copy of the given float.

float float ( from: String )

Converts a String to a float, following the same rules as String.to_float.

float float ( from: bool )

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.

float float ( from: int )

Cast an int value to a floating-point value, float(1) will be equal to 1.0.

运算符说明

bool operator != ( right: float )

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 != ( right: int )

Returns true if the integer has different value than the float.

Color **operator *** ( right: Color )

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 *** ( right: Quaternion )

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 *** ( right: Vector2 )

Multiplies each component of the Vector2 by the given float.


    print(2.5 * Vector2(1, 3)) # Prints "(2.5, 7.5)"

Vector2 **operator *** ( right: Vector2i )

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 *** ( right: Vector3 )

Multiplies each component of the Vector3 by the given float.

Vector3 **operator *** ( right: Vector3i )

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 *** ( right: Vector4 )

Multiplies each component of the Vector4 by the given float.

Vector4 **operator *** ( right: Vector4i )

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 *** ( right: float )

Multiplies two float s.

float **operator *** ( right: int )

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

float **operator **** ( right: float )

Raises a float to a power of a float.


    print(39.0625**0.25) # 2.5

float **operator **** ( right: int )

Raises a float to a power of an int. The result is a float.


    print(0.9**3) # 0.729

float operator + ( right: float )

Adds two floats.

float operator + ( right: int )

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

float operator - ( right: float )

Subtracts a float from a float.

float operator - ( right: int )

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

float operator / ( right: float )

Divides two floats.

float operator / ( right: int )

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

bool operator < ( right: float )

Returns true if the left float is less than the right one.

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 < ( right: int )

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

bool operator <= ( right: float )

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

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 <= ( right: int )

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

bool operator == ( right: float )

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.

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 == ( right: int )

Returns true if the float and the given int are equal.

bool operator > ( right: float )

Returns true if the left float is greater than the right one.

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 > ( right: int )

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

bool operator >= ( right: float )

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

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 >= ( right: int )

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.

1

本方法通常需要用户覆盖才能生效。

2

本方法无副作用，不会修改该实例的任何成员变量。

3

本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。

4

本方法用于构造某个类型。

5

调用本方法无需实例，可直接使用类名进行调用。

6

本方法描述的是使用本类型作为左操作数的有效运算符。

7

这个值是由下列位标志构成位掩码的整数。

8

无返回值。