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. See also Physics2DShapeQueryResult.

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

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_layer

Default	2147483647
Setter	set_collision_layer(value)
Getter	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

Default	[  ]
Setter	set_exclude(value)
Getter	get_exclude()

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

float margin

Default	0.0
Setter	set_margin(value)
Getter	get_margin()

The collision margin for the shape.

Vector2 motion

Default	Vector2( 0, 0 )
Setter	set_motion(value)
Getter	get_motion()

The motion of the shape being queried for.

RID shape_rid

Setter	set_shape_rid(value)
Getter	get_shape_rid()

The queried shape's RID. See also set_shape.

Transform2D transform

Default	Transform2D( 1, 0, 0, 1, 0, 0 )
Setter	set_transform(value)
Getter	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.