PhysicsTestMotionParameters2D¶
Inherits: RefCounted < Object
Parameters to be sent to a 2D body motion test.
Description¶
This class contains parameters used in PhysicsServer2D.body_test_motion.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
Property Descriptions¶
bool collide_separation_ray
Default |
|
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.
Array 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 |
|
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 |
|
Setter |
set_margin(value) |
Getter |
get_margin() |
Increases the size of the shapes involved in the collision detection.
Vector2 motion
Default |
|
Setter |
set_motion(value) |
Getter |
get_motion() |
Motion vector to define the length and direction of the motion to test.