Skip to content

Commit 608096e

Browse files
committed
Merge pull request #91581 from TheKiromen/improve-physics-server-documentation
Update `area_create` description in `PhysicsServer2D/3D` to clear up possible confusions
2 parents c01441e + 2b5e0d9 commit 608096e

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

doc/classes/PhysicsServer2D.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@
5252
<method name="area_create">
5353
<return type="RID" />
5454
<description>
55-
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.
55+
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].
56+
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].
5657
</description>
5758
</method>
5859
<method name="area_get_canvas_instance_id" qualifiers="const">

doc/classes/PhysicsServer3D.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@
4444
<method name="area_create">
4545
<return type="RID" />
4646
<description>
47-
Creates an [Area3D].
47+
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].
48+
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].
4849
</description>
4950
</method>
5051
<method name="area_get_collision_layer" qualifiers="const">

0 commit comments

Comments
 (0)