diff options
Diffstat (limited to 'doc/classes/float.xml')
| -rw-r--r-- | doc/classes/float.xml | 244 |
1 files changed, 226 insertions, 18 deletions
diff --git a/doc/classes/float.xml b/doc/classes/float.xml index 16a696f959..4bf04fe25f 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -4,36 +4,244 @@ Float built-in type. </brief_description> <description> - Float built-in type. + The [float] built-in type is a 64-bit double-precision floating-point number, equivalent to [code]double[/code] 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 [code]1.79769e308[/code], and the minimum is approximately [code]-1.79769e308[/code]. + Many methods and properties in the engine use 32-bit single-precision floating-point numbers instead, equivalent to [code]float[/code] 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 [code]float=64[/code] 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 [method @GlobalScope.is_equal_approx] and [method @GlobalScope.is_zero_approx] methods instead of [code]==[/code] to compare [float] values for equality. </description> <tutorials> + <link title="Wikipedia: Double-precision floating-point format">https://en.wikipedia.org/wiki/Double-precision_floating-point_format</link> + <link title="Wikipedia: Single-precision floating-point format">https://en.wikipedia.org/wiki/Single-precision_floating-point_format</link> </tutorials> <methods> - <method name="float"> - <return type="float"> - </return> - <argument index="0" name="from" type="bool"> - </argument> + <method name="float" qualifiers="constructor"> + <return type="float" /> + <description> + Constructs a default-initialized [float] set to [code]0.0[/code]. + </description> + </method> + <method name="float" qualifiers="constructor"> + <return type="float" /> + <argument index="0" name="from" type="float" /> + <description> + Constructs a [float] as a copy of the given [float]. + </description> + </method> + <method name="float" qualifiers="constructor"> + <return type="float" /> + <argument index="0" name="from" type="bool" /> <description> Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. </description> </method> - <method name="float"> - <return type="float"> - </return> - <argument index="0" name="from" type="int"> - </argument> + <method name="float" qualifiers="constructor"> + <return type="float" /> + <argument index="0" name="from" type="int" /> + <description> + Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code]. + </description> + </method> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="float" /> + <description> + Returns [code]true[/code] if two floats are different from each other. + </description> + </method> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="int" /> + <description> + Returns [code]true[/code] if the integer has different value than the float. + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="float" /> + <description> + Multiplies two [float]s. + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Multiplies each component of the [Vector2] by the given [float]. + [codeblock] + print(2.5 * Vector2(1, 1)) # Vector2(2.5, 2.5) + [/codeblock] + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector2i" /> + <argument index="0" name="right" type="Vector2i" /> + <description> + Multiplies each component of the [Vector2i] by the given [float]. + [codeblock] + print(2.0 * Vector2i(1, 1)) # Vector2i(2.0, 2.0) + [/codeblock] + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Multiplies each component of the [Vector3] by the given [float]. + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Vector3i" /> + <argument index="0" name="right" type="Vector3i" /> + <description> + Multiplies each component of the [Vector3i] by the given [float]. + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Quaternion" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + Multiplies each component of the [Quaternion] by the given [float]. + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + Multiplies each component of the [Color] by the given [float]. + [codeblock] + print(1.5 * Color(0.5, 0.5, 0.5)) # Color(0.75, 0.75, 0.75) + [/codeblock] + </description> + </method> + <method name="operator *" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="int" /> + <description> + Multiplies a [float] and an [int]. The result is a [float]. + </description> + </method> + <method name="operator +" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="float" /> + <description> + Adds two floats. + </description> + </method> + <method name="operator +" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="int" /> + <description> + Adds a [float] and an [int]. The result is a [float]. + </description> + </method> + <method name="operator -" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="float" /> + <description> + Subtracts a float from a float. + </description> + </method> + <method name="operator -" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="int" /> + <description> + Subtracts an [int] from a [float]. The result is a [float]. + </description> + </method> + <method name="operator /" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="float" /> + <description> + Divides two floats. + </description> + </method> + <method name="operator /" qualifiers="operator"> + <return type="float" /> + <argument index="0" name="right" type="int" /> + <description> + Divides a [float] by an [int]. The result is a [float]. + </description> + </method> + <method name="operator <" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="float" /> + <description> + Returns [code]true[/code] the left float is less than the right one. + </description> + </method> + <method name="operator <" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="int" /> + <description> + Returns [code]true[/code] if this [float] is less than the given [int]. + </description> + </method> + <method name="operator <=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="float" /> + <description> + Returns [code]true[/code] the left integer is less than or equal to the right one. + </description> + </method> + <method name="operator <=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="int" /> + <description> + Returns [code]true[/code] if this [float] is less than or equal to the given [int]. + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="float" /> + <description> + Returns [code]true[/code] if both floats are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method @GlobalScope.is_equal_approx] or [method @GlobalScope.is_zero_approx] instead, which are more reliable. + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="int" /> + <description> + Returns [code]true[/code] if the [float] and the given [int] are equal. + </description> + </method> + <method name="operator >" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="float" /> + <description> + Returns [code]true[/code] the left float is greater than the right one. + </description> + </method> + <method name="operator >" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="int" /> + <description> + Returns [code]true[/code] if this [float] is greater than the given [int]. + </description> + </method> + <method name="operator >=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="float" /> + <description> + Returns [code]true[/code] the left float is greater than or equal to the right one. + </description> + </method> + <method name="operator >=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="int" /> + <description> + Returns [code]true[/code] if this [float] is greater than or equal to the given [int]. + </description> + </method> + <method name="operator unary+" qualifiers="operator"> + <return type="float" /> <description> - Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to 1.0. + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> </method> - <method name="float"> - <return type="float"> - </return> - <argument index="0" name="from" type="String"> - </argument> + <method name="operator unary-" qualifiers="operator"> + <return type="float" /> <description> - Cast a [String] value to a floating-point value. This method accepts float value strings like [code]"1.23"[/code] and exponential notation strings for its parameter so calling [code]float("1e3")[/code] will return 1000.0 and calling [code]float("1e-3")[/code] will return 0.001. Calling this method with an invalid float string will return 0. This method stops parsing at the first invalid character and will return the parsed result so far, so calling [code]float("1a3")[/code] will return 1 while calling [code]float("1e3a2")[/code] will return 1000.0. + 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. </description> </method> </methods> |