PhysicsRayQueryParameters3D

Inherits:RefCounted<Object

Provides parameters forPhysicsDirectSpaceState3D.intersect_ray().

Description

By changing various properties of this object, such as the ray position, you can configure the parameters forPhysicsDirectSpaceState3D.intersect_ray().

Properties

bool

collide_with_areas

false

bool

collide_with_bodies

true

int

collision_mask

4294967295

Array[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(from:Vector3, to:Vector3, collision_mask:int = 4294967295, exclude:Array[RID] = [])static


Property Descriptions

boolcollide_with_areas =false🔗

Iftrue, the query will takeArea3Ds into account.


boolcollide_with_bodies =true🔗

Iftrue, the query will takePhysicsBody3Ds into account.


intcollision_mask =4294967295🔗

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


Array[RID]exclude =[]🔗

The list of objectRIDs that will be excluded from collisions. UseCollisionObject3D.get_rid() to get theRID associated with aCollisionObject3D-derived node.

Note: The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.


Vector3from =Vector3(0,0,0)🔗

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


boolhit_back_faces =true🔗

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


boolhit_from_inside =false🔗

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


Vector3to =Vector3(0,0,0)🔗

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


Method Descriptions

PhysicsRayQueryParameters3Dcreate(from:Vector3, to:Vector3, collision_mask:int = 4294967295, exclude:Array[RID] = [])static🔗

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

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

User-contributed notes

Please read theUser-contributed notes policy before submitting a comment.