mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-03-13 23:41:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #91581 from TheKiromen/improve-physics-server-documentation

Browse Source 
Update `area_create` description in `PhysicsServer2D/3D` to clear up possible confusions
This commit is contained in:
Rémi Verschelde 2024-05-06 15:15:32 +02:00
commit 608096e55e
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/PhysicsServer2D.xml
View File

@ -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">

3
doc/classes/PhysicsServer3D.xml
View File

@ -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">