PhysicsPointQueryParameters2D¶

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

Description¶

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

Properties¶

int	canvas_instance_id	`0`
bool	collide_with_areas	`false`
bool	collide_with_bodies	`true`
int	collision_mask	`4294967295`
Array	exclude	`[]`
Vector2	position	`Vector2(0, 0)`

Property Descriptions¶

int canvas_instance_id

Default	`0`
Setter	set_canvas_instance_id(value)
Getter	get_canvas_instance_id()

If different from 0, restricts the query to a specific canvas layer specified by its instance id. See Object.get_instance_id.

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.

Array exclude

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

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

Vector2 position

Default	`Vector2(0, 0)`
Setter	set_position(value)
Getter	get_position()

The position being queried for, in global coordinates.