Attention

You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Checking the stable version of the documentation...

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

PhysicsPointQueryParameters2D

Inherits: RefCounted < Object

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

RID[]

exclude

[]

Vector2

position

Vector2(0, 0)

Property Descriptions

int canvas_instance_id = 0

  • void set_canvas_instance_id ( int value )

  • int 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.

If 0, restricts the query to the Viewport's default canvas layer.

bool collide_with_areas = false

  • void set_collide_with_areas ( bool value )

  • 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 ( bool value )

  • bool is_collide_with_bodies_enabled ( )

If true, the query will take PhysicsBody2Ds into account.

int collision_mask = 4294967295

  • void set_collision_mask ( int value )

  • 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.

RID[] exclude = []

  • void set_exclude ( RID[] value )

  • 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.

Vector2 position = Vector2(0, 0)

The position being queried for, in global coordinates.