diff options
| author | Marcel Admiraal <madmiraal@users.noreply.github.com> | 2020-10-15 14:57:24 +0100 |
|---|---|---|
| committer | Marcel Admiraal <madmiraal@users.noreply.github.com> | 2020-10-15 16:44:57 +0100 |
| commit | e496db79d89a28d9913e052445d764fe68446207 (patch) | |
| tree | 0cbc35fb0d6a921e59684644edd5117aa581dc5e /doc/classes | |
| parent | e273f83be3d34a955bc831e6868d4c50a3a32d15 (diff) | |
Update intersect_point documentation to mention solid shapes.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/PhysicsDirectSpaceState2D.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/PhysicsDirectSpaceState2D.xml b/doc/classes/PhysicsDirectSpaceState2D.xml index 676e33601a..c26cf0514c 100644 --- a/doc/classes/PhysicsDirectSpaceState2D.xml +++ b/doc/classes/PhysicsDirectSpaceState2D.xml @@ -64,13 +64,14 @@ <argument index="5" name="collide_with_areas" type="bool" default="false"> </argument> <description> - Checks whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: + Checks whether a point is inside any solid shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]metadata[/code]: The intersecting shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method PhysicsServer2D.shape_set_data]. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody2D]s or [Area2D]s, respectively. + [b]Note:[/b] [ConcavePolygonShape2D]s and [CollisionPolygon2D]s in [code]Segments[/code] build mode are not solid shapes. Therefore, they will not be detected. </description> </method> <method name="intersect_point_on_canvas"> |