Browse Source

Add a note about collisions in different canvases.

(cherry picked from commit b9c91d620e829f2f4cea8037492ed6939e4aad87)
Markus Sauermann 3 years ago
parent
commit
b0b1e55305
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/CollisionObject2D.xml

+ 1 - 0
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>