Merge pull request #34032 from aaronfranke/approx-docs-hey-that-rhymes
Add docs for is_equal_approx on structures
This commit is contained in:
commit
dac2a7b237
11 changed files with 14 additions and 4 deletions
|
@ -182,6 +182,7 @@
|
||||||
<argument index="0" name="aabb" type="AABB">
|
<argument index="0" name="aabb" type="AABB">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="merge">
|
<method name="merge">
|
||||||
|
@ -190,7 +191,7 @@
|
||||||
<argument index="0" name="with" type="AABB">
|
<argument index="0" name="with" type="AABB">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns a larger AABB that contains this AABB and [code]with[/code].
|
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|
|
@ -102,6 +102,7 @@
|
||||||
<argument index="1" name="epsilon" type="float" default="0.00001">
|
<argument index="1" name="epsilon" type="float" default="0.00001">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="orthonormalized">
|
<method name="orthonormalized">
|
||||||
|
|
|
@ -157,6 +157,7 @@
|
||||||
<argument index="0" name="color" type="Color">
|
<argument index="0" name="color" type="Color">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="lightened">
|
<method name="lightened">
|
||||||
|
|
|
@ -122,6 +122,7 @@
|
||||||
<argument index="0" name="plane" type="Plane">
|
<argument index="0" name="plane" type="Plane">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_point_over">
|
<method name="is_point_over">
|
||||||
|
|
|
@ -100,6 +100,7 @@
|
||||||
<argument index="0" name="quat" type="Quat">
|
<argument index="0" name="quat" type="Quat">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this quaterion and [code]quat[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_normalized">
|
<method name="is_normalized">
|
||||||
|
|
|
@ -143,6 +143,7 @@
|
||||||
<argument index="0" name="rect" type="Rect2">
|
<argument index="0" name="rect" type="Rect2">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="merge">
|
<method name="merge">
|
||||||
|
@ -151,7 +152,7 @@
|
||||||
<argument index="0" name="b" type="Rect2">
|
<argument index="0" name="b" type="Rect2">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns a larger Rect2 that contains this Rect2 and [code]b[/code].
|
Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|
|
@ -95,6 +95,7 @@
|
||||||
<argument index="0" name="transform" type="Transform">
|
<argument index="0" name="transform" type="Transform">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="looking_at">
|
<method name="looking_at">
|
||||||
|
|
|
@ -112,6 +112,7 @@
|
||||||
<argument index="0" name="transform" type="Transform2D">
|
<argument index="0" name="transform" type="Transform2D">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="orthonormalized">
|
<method name="orthonormalized">
|
||||||
|
|
|
@ -159,6 +159,7 @@
|
||||||
<argument index="0" name="v" type="Vector2">
|
<argument index="0" name="v" type="Vector2">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_normalized">
|
<method name="is_normalized">
|
||||||
|
|
|
@ -135,6 +135,7 @@
|
||||||
<argument index="0" name="v" type="Vector3">
|
<argument index="0" name="v" type="Vector3">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_normalized">
|
<method name="is_normalized">
|
||||||
|
|
|
@ -502,7 +502,7 @@
|
||||||
<argument index="1" name="b" type="float">
|
<argument index="1" name="b" type="float">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns True/False whether [code]a[/code] and [code]b[/code] are approximately equal to each other.
|
Returns [code]true[/code] if [code]a[/code] and [code]b[/code] are approximately equal to each other.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_inf">
|
<method name="is_inf">
|
||||||
|
@ -538,7 +538,7 @@
|
||||||
<argument index="0" name="s" type="float">
|
<argument index="0" name="s" type="float">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns True/False whether [code]s[/code] is zero or almost zero.
|
Returns [code]true[/code] if [code]s[/code] is zero or almost zero.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="len">
|
<method name="len">
|
||||||
|
|
Loading…
Reference in a new issue