Table of Contents

Class PhysicsPointQueryParameters2D

Provides parameters for PhysicsDirectSpaceState2D.intersect_point.

Inheritance
PhysicsPointQueryParameters2D

Remarks

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

Properties

canvas_instance_id

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

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

var canvas_instance_id : int = 0

Property Value

int

Remarks

  • void set_canvas_instance_id(int value)
  • int get_canvas_instance_id

collide_with_areas

If true, the query will take Area2Ds into account.

var collide_with_areas : bool = false

Property Value

bool

Remarks

  • void set_collide_with_areas(bool value)
  • bool is_collide_with_areas_enabled

collide_with_bodies

If true, the query will take PhysicsBody2Ds into account.

var collide_with_bodies : bool = true

Property Value

bool

Remarks

  • void set_collide_with_bodies(bool value)
  • bool is_collide_with_bodies_enabled

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.

var collision_mask : int = 4294967295

Property Value

int

Remarks

  • void set_collision_mask(int value)
  • int get_collision_mask

exclude

The list of object RIDs that will be excluded from collisions. Use 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.

var exclude : RID[] = []

Property Value

RID[]

Remarks

position

The position being queried for, in global coordinates.

var position : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks