PhysicsRayQueryParameters2D

Provides parameters for PhysicsDirectSpaceState2D.intersect_ray.

Description

By changing various properties of this object, such as the ray position, you can configure the parameters for PhysicsDirectSpaceState2D.intersect_ray.

Properties


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

Methods


PhysicsRayQueryParameters2D	create(from: Vector2, to: Vector2, collision_mask: int = 4294967295, exclude: Array[RID] = []) static

Property Descriptions

bool collide_with_areas = false 🔗

void set_collide_with_areas(value: bool)
bool is_collide_with_areas_enabled()

If true, the query will take Area2Ds into account.

bool collide_with_bodies = true 🔗

void set_collide_with_bodies(value: bool)
bool is_collide_with_bodies_enabled()

If true, the query will take PhysicsBody2Ds into account.

int collision_mask = 4294967295 🔗

void set_collision_mask(value: int)
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.

Array[RID] exclude = [] 🔗

void set_exclude(value: Array[RID])
Array[RID] get_exclude()

The list of object RIDs that will be excluded from collisions. Use CollisionObject2D.get_rid to get the RID associated with a CollisionObject2D-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.

Vector2 from = Vector2(0, 0) 🔗

void set_from(value: Vector2)
Vector2 get_from()

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

bool hit_from_inside = false 🔗

void set_hit_from_inside(value: bool)
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 Vector2(0, 0). Does not affect concave polygon shapes.

Vector2 to = Vector2(0, 0) 🔗

void set_to(value: Vector2)
Vector2 get_to()

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

Method Descriptions

PhysicsRayQueryParameters2D create(from: Vector2, to: Vector2, collision_mask: int = 4294967295, exclude: Array[RID] = []) static 🔗

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

gdscript

var query = PhysicsRayQueryParameters2D.create(global_position, global_position + Vector2(0, 100))
var collision = get_world_2d().direct_space_state.intersect_ray(query)