diff options
Diffstat (limited to 'doc/classes/Plane.xml')
| -rw-r--r-- | doc/classes/Plane.xml | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index a20607d0a7..37a8e00b49 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -7,7 +7,7 @@ Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. </description> <tutorials> - <link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> </tutorials> <constructors> <constructor name="Plane"> @@ -180,6 +180,8 @@ <return type="bool" /> <argument index="0" name="right" type="Plane" /> <description> + Returns [code]true[/code] if the planes are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> </operator> <operator name="operator =="> @@ -191,16 +193,20 @@ <return type="bool" /> <argument index="0" name="right" type="Plane" /> <description> + Returns [code]true[/code] if the planes are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> </operator> <operator name="operator unary+"> <return type="Plane" /> <description> + 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> </operator> <operator name="operator unary-"> <return type="Plane" /> <description> + Returns the negative value of the [Plane]. This is the same as writing [code]Plane(-p.normal, -p.d)[/code]. This operation flips the direction of the normal vector and also flips the distance value, resulting in a Plane that is in the same place, but facing the opposite direction. </description> </operator> </operators> |