PhysicsRayQueryParameters3D¶

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`
Array	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, Array exclude=[] ) static

Property Descriptions¶

bool collide_with_areas

Default	`false`
Setter	set_collide_with_areas(value)
Getter	is_collide_with_areas_enabled()

If true, the query will take Area3Ds into account.

bool collide_with_bodies

Default	`true`
Setter	set_collide_with_bodies(value)
Getter	is_collide_with_bodies_enabled()

If true, the query will take PhysicsBody3Ds into account.

int collision_mask

Default	`4294967295`
Setter	set_collision_mask(value)
Getter	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.

Array exclude

Default	`[]`
Setter	set_exclude(value)
Getter	get_exclude()

The list of objects or object RIDs that will be excluded from collisions.

Vector3 from

Default	`Vector3(0, 0, 0)`
Setter	set_from(value)
Getter	get_from()

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

bool hit_back_faces

Default	`true`
Setter	set_hit_back_faces(value)
Getter	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

Default	`false`
Setter	set_hit_from_inside(value)
Getter	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

Default	`Vector3(0, 0, 0)`
Setter	set_to(value)
Getter	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, Array 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)