Class PhysicsShapeQueryParameters2D

Provides parameters for PhysicsDirectSpaceState2D.intersect_shape.

Inheritance

RefCounted

Object

PhysicsShapeQueryParameters2D

Remarks

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

Properties

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

• void set_exclude(RID[] value)
• RID[] get_exclude

margin

The collision margin for the shape.

var margin : float = 0.0

Property Value

float

Remarks

• void set_margin(float value)
• float get_margin

motion

The motion of the shape being queried for.

var motion : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_motion(Vector2 value)
• Vector2 get_motion

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.

var shape : Resource

Property Value

Resource

Remarks

• void set_shape(Resource value)
• Resource get_shape

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:

• gdscript
• C#

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)

var shape_rid : RID = RID()

Property Value

RID

Remarks

• void set_shape_rid(RID value)
• RID get_shape_rid

transform

The queried shape's transform matrix.

var transform : Transform2D = Transform2D(1, 0, 0, 1, 0, 0)

Property Value

Transform2D

Remarks

• void set_transform(Transform2D value)
• Transform2D get_transform