Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0
. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
PhysicsServer2D¶
Inherits: Object
Inherited By: PhysicsServer2DExtension
Server interface for low-level 2D physics access.
Description¶
PhysicsServer2D is the server responsible for all 2D physics. It can directly create and manipulate all physics objects:
A space is a self-contained world for a physics simulation. It contains bodies, areas, and joints. Its state can be queried for collision and intersection information, and several parameters of the simulation can be modified.
A shape is a geometric figure such as a circle, a rectangle, a capsule, or a polygon. It can be used for collision detection by adding it to a body/area, possibly with an extra transformation relative to the body/area's origin. Bodies/areas can have multiple (transformed) shapes added to them, and a single shape can be added to bodies/areas multiple times with different local transformations.
A body is a physical object which can be in static, kinematic, or rigid mode. Its state (such as position and velocity) can be queried and updated. A force integration callback can be set to customize the body's physics.
An area is a region in space which can be used to detect bodies and areas entering and exiting it. A body monitoring callback can be set to report entering/exiting body shapes, and similarly an area monitoring callback can be set. Gravity and damping can be overridden within the area by setting area parameters.
A joint is a constraint, either between two bodies or on one body relative to a point. Parameters such as the joint bias and the rest length of a spring joint can be adjusted.
Physics objects in the physics server may be created and manipulated independently; they do not have to be tied to nodes in the scene tree.
Note: All the physics nodes use the physics server internally. Adding a physics node to the scene tree will cause a corresponding physics object to be created in the physics server. A rigid body node registers a callback that updates the node's transform with the transform of the respective body object in the physics server (every physics update). An area node registers a callback to inform the area node about overlaps with the respective area object in the physics server. The raycast node queries the direct state of the relevant space in the physics server.
Methods¶
Enumerations¶
enum SpaceParameter:
SpaceParameter SPACE_PARAM_CONTACT_RECYCLE_RADIUS = 0
Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. The default value of this parameter is ProjectSettings.physics/2d/solver/contact_recycle_radius.
SpaceParameter SPACE_PARAM_CONTACT_MAX_SEPARATION = 1
Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded. The default value of this parameter is ProjectSettings.physics/2d/solver/contact_max_separation.
SpaceParameter SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION = 2
Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. The default value of this parameter is ProjectSettings.physics/2d/solver/contact_max_allowed_penetration.
SpaceParameter SPACE_PARAM_CONTACT_DEFAULT_BIAS = 3
Constant to set/get the default solver bias for all physics contacts. A solver bias is a factor controlling how much two objects "rebound", after overlapping, to avoid leaving them in that state because of numerical imprecision. The default value of this parameter is ProjectSettings.physics/2d/solver/default_contact_bias.
SpaceParameter SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD = 4
Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. The default value of this parameter is ProjectSettings.physics/2d/sleep_threshold_linear.
SpaceParameter SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD = 5
Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. The default value of this parameter is ProjectSettings.physics/2d/sleep_threshold_angular.
SpaceParameter SPACE_PARAM_BODY_TIME_TO_SLEEP = 6
Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. The default value of this parameter is ProjectSettings.physics/2d/time_before_sleep.
SpaceParameter SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS = 7
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. The default value of this parameter is ProjectSettings.physics/2d/solver/default_constraint_bias.
SpaceParameter SPACE_PARAM_SOLVER_ITERATIONS = 8
Constant to set/get the number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance. The default value of this parameter is ProjectSettings.physics/2d/solver/solver_iterations.
enum ShapeType:
ShapeType SHAPE_WORLD_BOUNDARY = 0
This is the constant for creating world boundary shapes. A world boundary shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
ShapeType SHAPE_SEPARATION_RAY = 1
This is the constant for creating separation ray shapes. A separation ray is defined by a length and separates itself from what is touching its far endpoint. Useful for character controllers.
ShapeType SHAPE_SEGMENT = 2
This is the constant for creating segment shapes. A segment shape is a finite line from a point A to a point B. It can be checked for intersections.
ShapeType SHAPE_CIRCLE = 3
This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks.
ShapeType SHAPE_RECTANGLE = 4
This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks.
ShapeType SHAPE_CAPSULE = 5
This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
ShapeType SHAPE_CONVEX_POLYGON = 6
This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks.
ShapeType SHAPE_CONCAVE_POLYGON = 7
This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.
ShapeType SHAPE_CUSTOM = 8
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
enum AreaParameter:
AreaParameter AREA_PARAM_GRAVITY_OVERRIDE_MODE = 0
Constant to set/get gravity override mode in an area. See AreaSpaceOverrideMode for possible values. The default value of this parameter is AREA_SPACE_OVERRIDE_DISABLED.
AreaParameter AREA_PARAM_GRAVITY = 1
Constant to set/get gravity strength in an area. The default value of this parameter is 9.80665
.
AreaParameter AREA_PARAM_GRAVITY_VECTOR = 2
Constant to set/get gravity vector/center in an area. The default value of this parameter is Vector2(0, -1)
.
AreaParameter AREA_PARAM_GRAVITY_IS_POINT = 3
Constant to set/get whether the gravity vector of an area is a direction, or a center point. The default value of this parameter is false
.
AreaParameter AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE = 4
Constant to set/get the distance at which the gravity strength is equal to the gravity controlled by AREA_PARAM_GRAVITY. For example, on a planet 100 pixels in radius with a surface gravity of 4.0 px/s², set the gravity to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 pixels from the center the gravity will be 1.0 px/s² (twice the distance, 1/4th the gravity), at 50 pixels it will be 16.0 px/s² (half the distance, 4x the gravity), and so on.
The above is true only when the unit distance is a positive number. When the unit distance is set to 0.0, the gravity will be constant regardless of distance. The default value of this parameter is 0.0
.
AreaParameter AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE = 5
Constant to set/get linear damping override mode in an area. See AreaSpaceOverrideMode for possible values. The default value of this parameter is AREA_SPACE_OVERRIDE_DISABLED.
AreaParameter AREA_PARAM_LINEAR_DAMP = 6
Constant to set/get the linear damping factor of an area. The default value of this parameter is 0.1
.
AreaParameter AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE = 7
Constant to set/get angular damping override mode in an area. See AreaSpaceOverrideMode for possible values. The default value of this parameter is AREA_SPACE_OVERRIDE_DISABLED.
AreaParameter AREA_PARAM_ANGULAR_DAMP = 8
Constant to set/get the angular damping factor of an area. The default value of this parameter is 1.0
.
AreaParameter AREA_PARAM_PRIORITY = 9
Constant to set/get the priority (order of processing) of an area. The default value of this parameter is 0
.
enum AreaSpaceOverrideMode:
AreaSpaceOverrideMode AREA_SPACE_OVERRIDE_DISABLED = 0
This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
AreaSpaceOverrideMode AREA_SPACE_OVERRIDE_COMBINE = 1
This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
AreaSpaceOverrideMode AREA_SPACE_OVERRIDE_COMBINE_REPLACE = 2
This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
AreaSpaceOverrideMode AREA_SPACE_OVERRIDE_REPLACE = 3
This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
AreaSpaceOverrideMode AREA_SPACE_OVERRIDE_REPLACE_COMBINE = 4
This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
enum BodyMode:
BodyMode BODY_MODE_STATIC = 0
Constant for static bodies. In this mode, a body can be only moved by user code and doesn't collide with other bodies along its path when moved.
BodyMode BODY_MODE_KINEMATIC = 1
Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
BodyMode BODY_MODE_RIGID = 2
Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.
BodyMode BODY_MODE_RIGID_LINEAR = 3
Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.
enum BodyParameter:
BodyParameter BODY_PARAM_BOUNCE = 0
Constant to set/get a body's bounce factor. The default value of this parameter is 0.0
.
BodyParameter BODY_PARAM_FRICTION = 1
Constant to set/get a body's friction. The default value of this parameter is 1.0
.
BodyParameter BODY_PARAM_MASS = 2
Constant to set/get a body's mass. The default value of this parameter is 1.0
. If the body's mode is set to BODY_MODE_RIGID, then setting this parameter will have the following additional effects:
If the parameter BODY_PARAM_CENTER_OF_MASS has never been set explicitly, then the value of that parameter will be recalculated based on the body's shapes.
If the parameter BODY_PARAM_INERTIA is set to a value
<= 0.0
, then the value of that parameter will be recalculated based on the body's shapes, mass, and center of mass.
BodyParameter BODY_PARAM_INERTIA = 3
Constant to set/get a body's inertia. The default value of this parameter is 0.0
. If the body's inertia is set to a value <= 0.0
, then the inertia will be recalculated based on the body's shapes, mass, and center of mass.
BodyParameter BODY_PARAM_CENTER_OF_MASS = 4
Constant to set/get a body's center of mass position in the body's local coordinate system. The default value of this parameter is Vector2(0,0)
. If this parameter is never set explicitly, then it is recalculated based on the body's shapes when setting the parameter BODY_PARAM_MASS or when calling body_set_space.
BodyParameter BODY_PARAM_GRAVITY_SCALE = 5
Constant to set/get a body's gravity multiplier. The default value of this parameter is 1.0
.
BodyParameter BODY_PARAM_LINEAR_DAMP_MODE = 6
Constant to set/get a body's linear damping mode. See BodyDampMode for possible values. The default value of this parameter is BODY_DAMP_MODE_COMBINE.
BodyParameter BODY_PARAM_ANGULAR_DAMP_MODE = 7
Constant to set/get a body's angular damping mode. See BodyDampMode for possible values. The default value of this parameter is BODY_DAMP_MODE_COMBINE.
BodyParameter BODY_PARAM_LINEAR_DAMP = 8
Constant to set/get a body's linear damping factor. The default value of this parameter is 0.0
.
BodyParameter BODY_PARAM_ANGULAR_DAMP = 9
Constant to set/get a body's angular damping factor. The default value of this parameter is 0.0
.
BodyParameter BODY_PARAM_MAX = 10
Represents the size of the BodyParameter enum.
enum BodyDampMode:
BodyDampMode BODY_DAMP_MODE_COMBINE = 0
The body's damping value is added to any value set in areas or the default value.
BodyDampMode BODY_DAMP_MODE_REPLACE =