PhysicsShapeQueryParameters2D

Inherits: RefCounted < Object

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

Description

This class contains the shape and other parameters for PhysicsDirectSpaceState2D intersection/collision queries.

Properties

bool

collide_with_areas

false

bool

collide_with_bodies

true

int

collision_mask

4294967295

Array

exclude

[]

float

margin

0.0

Vector2

motion

Vector2(0, 0)

Resource

shape

RID

shape_rid

Transform2D

transform

Transform2D(1, 0, 0, 1, 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

0.0

Setter

set_margin(value)

Getter

get_margin()

The collision margin for the shape.


Default

Vector2(0, 0)

Setter

set_motion(value)

Getter

get_motion()

The motion of the shape being queried for.


Setter

set_shape(value)

Getter

get_shape()

The Shape2D that will be used for collision/intersection queries. This stores the actual reference which avoids the shape to be released while being used for queries, so always prefer using this over shape_rid.


  • RID shape_rid

Setter

set_shape_rid(value)

Getter

get_shape_rid()

The queried shape's RID that will be used for collision/intersection queries. Use this over shape if you want to optimize for performance using the Servers API:

var shape_rid = PhysicsServer2D.circle_shape_create()
var radius = 64
PhysicsServer2D.shape_set_data(shape_rid, radius)

var params = PhysicsShapeQueryParameters2D.new()
params.shape_rid = shape_rid

# Execute physics queries here...

# Release the shape when done with physics queries.
PhysicsServer2D.free_rid(shape_rid)

Default

Transform2D(1, 0, 0, 1, 0, 0)

Setter

set_transform(value)

Getter

get_transform()

The queried shape's transform matrix.