summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Sauermann <6299227+Sauermann@users.noreply.github.com>2022-04-08 09:27:31 +0200
committerMarkus Sauermann <6299227+Sauermann@users.noreply.github.com>2022-04-08 09:27:31 +0200
commitb9c91d620e829f2f4cea8037492ed6939e4aad87 (patch)
treed8dfcf9876549dd68745e10f6ad6e9086bb9fc96
parentbf153b82c73755bf898df9de33ac2116ebe914b9 (diff)
Add a note about collisions in different canvases.
-rw-r--r--doc/classes/CollisionObject2D.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml
index 99bf9f7853..5d025985cc 100644
--- a/doc/classes/CollisionObject2D.xml
+++ b/doc/classes/CollisionObject2D.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods.
+ [b]Note:[/b] Only collisions between objects within the same canvas ([Viewport] canvas or [CanvasLayer]) are supported. The behavior of collisions between objects in different canvases is undefined.
</description>
<tutorials>
</tutorials>