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 create many kinds of physics objects, but does not insert them on the node tree.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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. Unlike the CollisionPolygon2D.polygon property, polygons modified with shape_set_data do not verify that the points supplied form is a convex polygon.
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.
AreaParameter AREA_PARAM_GRAVITY = 1
Constant to set/get gravity strength in an area.
AreaParameter AREA_PARAM_GRAVITY_VECTOR = 2
Constant to set/get gravity vector/center in an area.
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.
AreaParameter AREA_PARAM_GRAVITY_DISTANCE_SCALE = 4
Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
AreaParameter AREA_PARAM_GRAVITY_POINT_ATTENUATION = 5
This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
AreaParameter AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE = 6
Constant to set/get linear damping override mode in an area. See AreaSpaceOverrideMode for possible values.
AreaParameter AREA_PARAM_LINEAR_DAMP = 7
Constant to set/get the linear damping factor of an area.
AreaParameter AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE = 8
Constant to set/get angular damping override mode in an area. See AreaSpaceOverrideMode for possible values.
AreaParameter AREA_PARAM_ANGULAR_DAMP = 9
Constant to set/get the angular damping factor of an area.
AreaParameter AREA_PARAM_PRIORITY = 10
Constant to set/get the priority (order of processing) of an area.
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.
BodyParameter BODY_PARAM_FRICTION = 1
Constant to set/get a body's friction.
BodyParameter BODY_PARAM_MASS = 2
Constant to set/get a body's mass.
BodyParameter BODY_PARAM_INERTIA = 3
Constant to set/get a body's inertia.
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.
BodyParameter BODY_PARAM_GRAVITY_SCALE = 5
Constant to set/get a body's gravity multiplier.
BodyParameter BODY_PARAM_LINEAR_DAMP_MODE = 6
Constant to set/get a body's linear dampening mode. See BodyDampMode for possible values.
BodyParameter BODY_PARAM_ANGULAR_DAMP_MODE = 7
Constant to set/get a body's angular dampening mode. See BodyDampMode for possible values.
BodyParameter BODY_PARAM_LINEAR_DAMP = 8
Constant to set/get a body's linear dampening factor.
BodyParameter BODY_PARAM_ANGULAR_DAMP = 9
Constant to set/get a body's angular dampening factor.
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 = 1
The body's damping value replaces any value set in areas or the default value.
enum BodyState:
BodyState BODY_STATE_TRANSFORM = 0
Constant to set/get the current transform matrix of the body.
BodyState BODY_STATE_LINEAR_VELOCITY = 1
Constant to set/get the current linear velocity of the body.
BodyState BODY_STATE_ANGULAR_VELOCITY = 2
Constant to set/get the current angular velocity of the body.
BodyState BODY_STATE_SLEEPING = 3
Constant to sleep/wake up a body, or to get whether it is sleeping.