PhysicsRayQueryParameters2D

Inherits: RefCounted < Object

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

Description

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

Properties

bool

collide_with_areas

false

bool

collide_with_bodies

true

int

collision_mask

4294967295

Array

exclude

[]

Vector2

from

Vector2(0, 0)

bool

hit_from_inside

false

Vector2

to

Vector2(0, 0)

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 Area2Ds 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 PhysicsBody2Ds 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.


Default

[]

Setter

set_exclude(value)

Getter

get_exclude()

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


Default

Vector2(0, 0)

Setter

set_from(value)

Getter

get_from()

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


  • 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 Vector2(0, 0). Does not affect concave polygon shapes.


Default

Vector2(0, 0)

Setter

set_to(value)

Getter

get_to()

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