Physics2DShapeQueryParameters

Inherits: Reference < Object

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

Description

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

Properties

bool	collide_with_areas	false
bool	collide_with_bodies	true
int	collision_layer	2147483647
Array	exclude	[  ]
float	margin	0.0
Vector2	motion	Vector2( 0, 0 )
RID	shape_rid
Transform2D	transform	Transform2D( 1, 0, 0, 1, 0, 0 )

Methods

void	set_shape ( Resource shape )

---

Property Descriptions

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_layer = 2147483647

• void set_collision_layer ( int value )

• int get_collision_layer ( )

The physics layer(s) the query will take into account (as a bitmask). See Collision layers and masks in the documentation for more information.

---

Array exclude = [  ]

• void set_exclude ( Array value )

• Array get_exclude ( )

The list of objects or object RIDs that will be excluded from collisions.

---

float margin = 0.0

• void set_margin ( float value )

• float get_margin ( )

The collision margin for the shape.

---

Vector2 motion = Vector2( 0, 0 )

• void set_motion ( Vector2 value )

• Vector2 get_motion ( )

The motion of the shape being queried for.

---

RID shape_rid

• void set_shape_rid ( RID value )

• RID get_shape_rid ( )

The queried shape's RID. See also set_shape.

---

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

• void set_transform ( Transform2D value )

• Transform2D get_transform ( )

The queried shape's transform matrix.

---

Method Descriptions

void set_shape ( Resource shape )

Sets the Shape2D that will be used for collision/intersection queries.