Attention

You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Checking the stable version of the documentation...

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

PhysicsRayQueryParameters3D

Inherits: RefCounted < Object

Parameters to be sent to a 3D ray physics query.

Description

This class contains the ray position and other parameters to be used for PhysicsDirectSpaceState3D.intersect_ray.

Properties

bool	collide_with_areas	false
bool	collide_with_bodies	true
int	collision_mask	4294967295
RID[]	exclude	[]
Vector3	from	Vector3(0, 0, 0)
bool	hit_back_faces	true
bool	hit_from_inside	false
Vector3	to	Vector3(0, 0, 0)

Methods

PhysicsRayQueryParameters3D

create ( Vector3 from, Vector3 to, int collision_mask=4294967295, RID[] exclude=[] ) static

---

Property Descriptions

bool collide_with_areas = false

• void set_collide_with_areas ( bool value )

• bool is_collide_with_areas_enabled ( )

If true, the query will take Area3Ds into account.

---

bool collide_with_bodies = true

• void set_collide_with_bodies ( bool value )

• bool is_collide_with_bodies_enabled ( )

If true, the query will take PhysicsBody3Ds into account.

---

int collision_mask = 4294967295

• void set_collision_mask ( int value )

• int get_collision_mask ( )

The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See Collision layers and masks in the documentation for more information.

---

RID[] exclude = []

• void set_exclude ( RID[] value )

• RID[] get_exclude ( )

The list of object RIDs that will be excluded from collisions. Use CollisionObject3D.get_rid to get the RID associated with a CollisionObject3D-derived node.

---

Vector3 from = Vector3(0, 0, 0)

• void set_from ( Vector3 value )

• Vector3 get_from ( )

The starting point of the ray being queried for, in global coordinates.

---

bool hit_back_faces = true

• void set_hit_back_faces ( bool value )

• bool is_hit_back_faces_enabled ( )

If true, the query will hit back faces with concave polygon shapes with back face enabled or heightmap shapes.

---

bool hit_from_inside = false

• void set_hit_from_inside ( bool value )

• bool is_hit_from_inside_enabled ( )

If true, the query will detect a hit when starting inside shapes. In this case the collision normal will be Vector3(0, 0, 0). Does not affect concave polygon shapes or heightmap shapes.

---

Vector3 to = Vector3(0, 0, 0)

• void set_to ( Vector3 value )

• Vector3 get_to ( )

The ending point of the ray being queried for, in global coordinates.

---

Method Descriptions

PhysicsRayQueryParameters3D create ( Vector3 from, Vector3 to, int collision_mask=4294967295, RID[] exclude=[] ) static

Returns a new, pre-configured PhysicsRayQueryParameters3D object. Use it to quickly create query parameters using the most common options.

var query = PhysicsRayQueryParameters3D.create(position, position + Vector3(0, -10, 0))
var collision = get_world_3d().direct_space_state.intersect_ray(query)