Skip to content

Commit

Permalink
Merge pull request #91581 from TheKiromen/improve-physics-server-docu…
Browse files Browse the repository at this point in the history
…mentation

Update `area_create` description in `PhysicsServer2D/3D` to clear up possible confusions
  • Loading branch information
akien-mga committed May 6, 2024
2 parents c01441e + 2b5e0d9 commit 608096e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion doc/classes/PhysicsServer2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@
<method name="area_create">
<return type="RID" />
<description>
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].
</description>
</method>
<method name="area_get_canvas_instance_id" qualifiers="const">
Expand Down
3 changes: 2 additions & 1 deletion doc/classes/PhysicsServer3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
<method name="area_create">
<return type="RID" />
<description>
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].
</description>
</method>
<method name="area_get_collision_layer" qualifiers="const">
Expand Down

0 comments on commit 608096e

Please sign in to comment.