diff options
| author | Dominik Kruczek <TheKiromen@gmail.com> | 2024-05-05 14:28:07 +0200 |
|---|---|---|
| committer | Dominik Kruczek <TheKiromen@gmail.com> | 2024-05-05 19:38:21 +0200 |
| commit | 2b5e0d98d2010d519b8d05417f804961ea8fb3df (patch) | |
| tree | c8b67a644314912853701fc00f084abf75808c89 | |
| parent | 7ebc866418b075df58cbe4e31fcf8b0c3acd70a1 (diff) | |
| download | redot-engine-2b5e0d98d2010d519b8d05417f804961ea8fb3df.tar.gz | |
Update area_create description in PhysicsServer2D/3D to clear up possible confusions
| -rw-r--r-- | doc/classes/PhysicsServer2D.xml | 3 | ||||
| -rw-r--r-- | 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 d40326fa21..def0c2bd91 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -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"> diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 4a4a1ad025..28ef03614a 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -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"> |