From e9eddb4f1f4a443d9fb46e76aecb6b262621f664 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 21 Sep 2020 14:27:50 +0200 Subject: [PATCH] Cross-reference AABB and Rect2 in the class reference --- doc/classes/AABB.xml | 4 +++- doc/classes/Rect2.xml | 3 ++- doc/classes/Rect2i.xml | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index cbc04ca672a..faa380ff33f 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -4,7 +4,9 @@ Axis-Aligned Bounding Box. - AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + [AABB] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + It uses floating-point coordinates. The 2D counterpart to [AABB] is [Rect2]. + [b]Note:[/b] Unlike [Rect2], [AABB] does not have a variant that uses integer coordinates. https://docs.godotengine.org/en/latest/tutorials/math/index.html diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index fe05f14fa16..2d1685871d3 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -5,7 +5,8 @@ [Rect2] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. - It uses floating point coordinates. + It uses floating-point coordinates. If you need integer coordinates, use [Rect2i] instead. + The 3D counterpart to [Rect2] is [AABB]. https://docs.godotengine.org/en/latest/tutorials/math/index.html diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index 2fdfe7c24bf..809f385f6ec 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -5,7 +5,7 @@ [Rect2i] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. - It uses integer coordinates. + It uses integer coordinates. If you need floating-point coordinates, use [Rect2] instead. https://docs.godotengine.org/en/latest/tutorials/math/index.html