PhysicsTestMotionParameters2D¶

Parameters to be sent to a 2D body motion test.

Description¶

This class contains parameters used in PhysicsServer2D.body_test_motion.

Properties¶

bool	collide_separation_ray	`false`
RID[]	exclude_bodies	`[]`
Array	exclude_objects	`[]`
Transform2D	from	`Transform2D(1, 0, 0, 1, 0, 0)`
float	margin	`0.08`
Vector2	motion	`Vector2(0, 0)`
bool	recovery_as_collision	`false`

Property Descriptions¶

bool collide_separation_ray

Default	`false`
Setter	set_collide_separation_ray_enabled(value)
Getter	is_collide_separation_ray_enabled()

If set to true, shapes of type PhysicsServer2D.SHAPE_SEPARATION_RAY are used to detect collisions and can stop the motion. Can be useful when snapping to the ground.

If set to false, shapes of type PhysicsServer2D.SHAPE_SEPARATION_RAY are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes.

RID[] exclude_bodies

Default	`[]`
Setter	set_exclude_bodies(value)
Getter	get_exclude_bodies()

Optional array of body RID to exclude from collision.

Array exclude_objects

Default	`[]`
Setter	set_exclude_objects(value)
Getter	get_exclude_objects()

Optional array of object unique instance ID to exclude from collision. See Object.get_instance_id.

Transform2D from

Default	`Transform2D(1, 0, 0, 1, 0, 0)`
Setter	set_from(value)
Getter	get_from()

Transform in global space where the motion should start. Usually set to Node2D.global_transform for the current body's transform.

float margin

Default	`0.08`
Setter	set_margin(value)
Getter	get_margin()

Increases the size of the shapes involved in the collision detection.

Vector2 motion

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

Motion vector to define the length and direction of the motion to test.

bool recovery_as_collision

Default	`false`
Setter	set_recovery_as_collision_enabled(value)
Getter	is_recovery_as_collision_enabled()

If set to true, any depenetration from the recovery phase is reported as a collision; this is used e.g. by CharacterBody2D.move_and_slide for improving floor detection when floor snapping is disabled.

If set to false, only collisions resulting from the motion are reported; this is used e.g. by PhysicsBody2D.move_and_collide.