|
@@ -16,7 +16,7 @@
|
|
|
<return type="Variant" />
|
|
|
<param index="0" name="x" type="Variant" />
|
|
|
<description>
|
|
|
- Returns the absolute value of a [Variant] parameter [param x] (i.e. non-negative value). Variant types [int], [float], [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported.
|
|
|
+ Returns the absolute value of a [Variant] parameter [param x] (i.e. non-negative value). Supported types: [int], [float], [Vector2], [Vector2i], [Vector3], [Vector3i], [Vector4], [Vector4i].
|
|
|
[codeblock]
|
|
|
var a = abs(-1)
|
|
|
# a is 1
|
|
@@ -36,6 +36,7 @@
|
|
|
var f = abs(Vector3i(-7, -8, -9))
|
|
|
# f is (7, 8, 9)
|
|
|
[/codeblock]
|
|
|
+ [b]Note:[/b] For better type safety, use [method absf], [method absi], [method Vector2.abs], [method Vector2i.abs], [method Vector3.abs], [method Vector3i.abs], [method Vector4.abs], or [method Vector4i.abs].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="absf">
|
|
@@ -154,7 +155,7 @@
|
|
|
i = ceil(1.001) # i is 2.0
|
|
|
[/codeblock]
|
|
|
See also [method floor], [method round], and [method snapped].
|
|
|
- [b]Note:[/b] For better type safety, see [method ceilf], [method ceili], [method Vector2.ceil], [method Vector3.ceil] and [method Vector4.ceil].
|
|
|
+ [b]Note:[/b] For better type safety, use [method ceilf], [method ceili], [method Vector2.ceil], [method Vector3.ceil], or [method Vector4.ceil].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="ceilf">
|
|
@@ -179,7 +180,7 @@
|
|
|
<param index="1" name="min" type="Variant" />
|
|
|
<param index="2" name="max" type="Variant" />
|
|
|
<description>
|
|
|
- Clamps the [param value], returning a [Variant] not less than [param min] and not more than [param max]. Variant types [int], [float], [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported.
|
|
|
+ Clamps the [param value], returning a [Variant] not less than [param min] and not more than [param max]. Supported types: [int], [float], [Vector2], [Vector2i], [Vector3], [Vector3i], [Vector4], [Vector4i].
|
|
|
[codeblock]
|
|
|
var a = clamp(-10, -1, 5)
|
|
|
# a is -1
|
|
@@ -199,6 +200,7 @@
|
|
|
var f = clamp(Vector3i(-7, -8, -9), Vector3i(-1, 2, 3), Vector3i(-4, -5, -6))
|
|
|
# f is (-4, -5, -6)
|
|
|
[/codeblock]
|
|
|
+ [b]Note:[/b] For better type safety, use [method clampf], [method clampi], [method Vector2.clamp], [method Vector2i.clamp], [method Vector3.clamp], [method Vector3i.clamp], [method Vector4.clamp], or [method Vector4i.clamp].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="clampf">
|
|
@@ -378,7 +380,7 @@
|
|
|
a = floor(-2.99) # a is -3.0
|
|
|
[/codeblock]
|
|
|
See also [method ceil], [method round], and [method snapped].
|
|
|
- [b]Note:[/b] For better type safety, see [method floorf], [method floori], [method Vector2.floor], [method Vector3.floor] and [method Vector4.floor].
|
|
|
+ [b]Note:[/b] For better type safety, use [method floorf], [method floori], [method Vector2.floor], [method Vector3.floor], or [method Vector4.floor].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="floorf">
|
|
@@ -960,7 +962,7 @@
|
|
|
round(2.6) # Returns 3
|
|
|
[/codeblock]
|
|
|
See also [method floor], [method ceil], and [method snapped].
|
|
|
- [b]Note:[/b] For better type safety, use [method roundf], [method roundi], [method Vector2.round], [method Vector3.round] or [method Vector4.round], instead.
|
|
|
+ [b]Note:[/b] For better type safety, use [method roundf], [method roundi], [method Vector2.round], [method Vector3.round], or [method Vector4.round].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="roundf">
|
|
@@ -997,21 +999,22 @@
|
|
|
<return type="Variant" />
|
|
|
<param index="0" name="x" type="Variant" />
|
|
|
<description>
|
|
|
- Returns the sign of [param x] as same type of [Variant] as [param x] with each component being -1, 0 and 1 for each negative, zero and positive values respectively. Variant types [int], [float], [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported.
|
|
|
+ Returns the same type of [Variant] as [param x], with [code]-1[/code] for negative values, [code]1[/code] for positive values, and [code]0[/code] for zeros. Supported types: [int], [float], [Vector2], [Vector2i], [Vector3], [Vector3i], [Vector4], [Vector4i].
|
|
|
[codeblock]
|
|
|
sign(-6.0) # Returns -1
|
|
|
sign(0.0) # Returns 0
|
|
|
sign(6.0) # Returns 1
|
|
|
|
|
|
- sign(Vector3(-6.0, 0.0, 6.0) # Returns (-1, 0, 1)
|
|
|
+ sign(Vector3(-6.0, 0.0, 6.0)) # Returns (-1, 0, 1)
|
|
|
[/codeblock]
|
|
|
+ [b]Note:[/b] For better type safety, use [method signf], [method signi], [method Vector2.sign], [method Vector2i.sign], [method Vector3.sign], [method Vector3i.sign], [method Vector4.sign], or [method Vector4i.sign].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="signf">
|
|
|
<return type="float" />
|
|
|
<param index="0" name="x" type="float" />
|
|
|
<description>
|
|
|
- Returns the sign of [param x] as a [float]: -1.0 or 1.0. Returns 0.0 if [param x] is 0.0.
|
|
|
+ Returns [code]-1.0[/code] if [param x] is negative, [code]1.0[/code] if [param x] is positive, and [code]0.0[/code] if if [param x] is zero.
|
|
|
[codeblock]
|
|
|
sign(-6.5) # Returns -1.0
|
|
|
sign(0.0) # Returns 0.0
|
|
@@ -1023,7 +1026,7 @@
|
|
|
<return type="int" />
|
|
|
<param index="0" name="x" type="int" />
|
|
|
<description>
|
|
|
- Returns the sign of [param x] as an [int]: -1 or 1. Returns 0 if [param x] is 0.
|
|
|
+ Returns [code]-1[/code] if [param x] is negative, [code]1[/code] if [param x] is positive, and [code]0[/code] if if [param x] is zero.
|
|
|
[codeblock]
|
|
|
sign(-6) # Returns -1
|
|
|
sign(0) # Returns 0
|
|
@@ -1073,16 +1076,46 @@
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="snapped">
|
|
|
+ <return type="Variant" />
|
|
|
+ <param index="0" name="x" type="Variant" />
|
|
|
+ <param index="1" name="step" type="Variant" />
|
|
|
+ <description>
|
|
|
+ Returns the multiple of [param step] that is the closest to [param x]. This can also be used to round a floating point number to an arbitrary number of decimals.
|
|
|
+ The returned value is the same type of [Variant] as [param step]. Supported types: [int], [float], [Vector2], [Vector2i], [Vector3], [Vector3i], [Vector4], [Vector4i].
|
|
|
+ [codeblock]
|
|
|
+ snapped(100, 32) # Returns 96
|
|
|
+ snapped(3.14159, 0.01) # Returns 3.14
|
|
|
+
|
|
|
+ snapped(Vector2(34, 70), Vector2(8, 8)) # Returns (32, 72)
|
|
|
+ [/codeblock]
|
|
|
+ See also [method ceil], [method floor], and [method round].
|
|
|
+ [b]Note:[/b] For better type safety, use [method snappedf], [method snappedi], [method Vector2.snapped], [method Vector2i.snapped], [method Vector3.snapped], [method Vector3i.snapped], [method Vector4.snapped], or [method Vector4i.snapped].
|
|
|
+ </description>
|
|
|
+ </method>
|
|
|
+ <method name="snappedf">
|
|
|
<return type="float" />
|
|
|
<param index="0" name="x" type="float" />
|
|
|
<param index="1" name="step" type="float" />
|
|
|
<description>
|
|
|
- Snaps the float value [param x] to a given [param step]. This can also be used to round a floating point number to an arbitrary number of decimals.
|
|
|
+ Returns the multiple of [param step] that is the closest to [param x]. This can also be used to round a floating point number to an arbitrary number of decimals.
|
|
|
+ A type-safe version of [method snapped], returning a [float].
|
|
|
[codeblock]
|
|
|
- snapped(100, 32) # Returns 96
|
|
|
- snapped(3.14159, 0.01) # Returns 3.14
|
|
|
+ snapped(32.0, 2.5) # Returns 32.5
|
|
|
+ snapped(3.14159, 0.01) # Returns 3.14
|
|
|
+ [/codeblock]
|
|
|
+ </description>
|
|
|
+ </method>
|
|
|
+ <method name="snappedi">
|
|
|
+ <return type="int" />
|
|
|
+ <param index="0" name="x" type="float" />
|
|
|
+ <param index="1" name="step" type="int" />
|
|
|
+ <description>
|
|
|
+ Returns the multiple of [param step] that is the closest to [param x].
|
|
|
+ A type-safe version of [method snapped], returning an [int].
|
|
|
+ [codeblock]
|
|
|
+ snapped(53, 16) # Returns 48
|
|
|
+ snapped(4096, 100) # Returns 4100
|
|
|
[/codeblock]
|
|
|
- See also [method ceil], [method floor], and [method round].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="sqrt">
|