PhysicsShapeQueryParameters2D | Godot Docs 4.3

class-description

NEWS

COMMUNITY

STORE

TUTORIALS

LOGOUT

LOGOUT

Object

PhysicsShapeQueryParameters2D

Provides parameters for PhysicsDirectSpaceState2D.intersect_shape.

By changing various properties of this object, such as the shape, you can configure the parameters for PhysicsDirectSpaceState2D.intersect_shape.

bool

collide_with_areas

()

:bool

If true, the query will take Area2Ds into account.

bool

collide_with_bodies

()

:bool

If true, the query will take PhysicsBody2Ds into account.

int

collision_mask

()

:int

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

()

:RID[]

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.

float

margin

()

:float

The collision margin for the shape.

Vector2

motion

()

:Vector2

The motion of the shape being queried for.

Resource

shape

()

:Resource

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

()

: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)

Transform2D

transform

()

:Transform2D

The queried shape's transform matrix.