From 2b5e0d98d2010d519b8d05417f804961ea8fb3df Mon Sep 17 00:00:00 2001 From: Dominik Kruczek Date: Sun, 5 May 2024 14:28:07 +0200 Subject: [PATCH] Update area_create description in PhysicsServer2D/3D to clear up possible confusions --- doc/classes/PhysicsServer2D.xml | 3 ++- doc/classes/PhysicsServer3D.xml | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index d40326fa2182..def0c2bd91ca 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -52,7 +52,8 @@ - Creates a 2D area object in the physics server, and returns the [RID] that identifies it. Use [method area_add_shape] to add shapes to it, use [method area_set_transform] to set its transform, and use [method area_set_space] to add the area to a space. + Creates a 2D area object in the physics server, and returns the [RID] that identifies it. The default settings for the created area include a collision layer and mask set to [code]1[/code], and [code]monitorable[/code] set to [code]false[/code]. + Use [method area_add_shape] to add shapes to it, use [method area_set_transform] to set its transform, and use [method area_set_space] to add the area to a space. If you want the area to be detectable use [method area_set_monitorable]. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 4a4a1ad02511..28ef03614aeb 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -44,7 +44,8 @@ - Creates an [Area3D]. + Creates a 3D area object in the physics server, and returns the [RID] that identifies it. The default settings for the created area include a collision layer and mask set to [code]1[/code], and [code]monitorable[/code] set to [code]false[/code]. + Use [method area_add_shape] to add shapes to it, use [method area_set_transform] to set its transform, and use [method area_set_space] to add the area to a space. If you want the area to be detectable use [method area_set_monitorable].