PhysicsServer2D¶
Inherits: Object
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:
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.
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.
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.
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.
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.
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.
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.
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.
SPACE_PARAM_SOLVER_ITERATIONS = 8 --- Constant to set/get the number of solver iterations for all contacts and constraints. The greater the amount of iterations, the more accurate the collisions will be. However, a greater amount of iterations requires more CPU power, which can decrease performance.
enum 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.
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.
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.
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.
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.
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.
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.
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.
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:
AREA_PARAM_GRAVITY_OVERRIDE_MODE = 0 --- Constant to set/get gravity override mode in an area. See AreaSpaceOverrideMode for possible values.
AREA_PARAM_GRAVITY = 1 --- Constant to set/get gravity strength in an area.
AREA_PARAM_GRAVITY_VECTOR = 2 --- Constant to set/get gravity vector/center in an area.
AREA_PARAM_GRAVITY_IS_POINT = 3 --- Constant to set/get whether the gravity vector of an area is a direction, or a center point.
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.
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.
AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE = 6 --- Constant to set/get linear damping override mode in an area. See AreaSpaceOverrideMode for possible values.
AREA_PARAM_LINEAR_DAMP = 7 --- Constant to set/get the linear damping factor of an area.
AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE = 8 --- Constant to set/get angular damping override mode in an area. See AreaSpaceOverrideMode for possible values.
AREA_PARAM_ANGULAR_DAMP = 9 --- Constant to set/get the angular damping factor of an area.
AREA_PARAM_PRIORITY = 10 --- Constant to set/get the priority (order of processing) of an area.
enum 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.
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.
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.
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.
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:
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.
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.
BODY_MODE_DYNAMIC = 2 --- Constant for dynamic bodies. In this mode, a body can be pushed by other bodies and has forces applied.
BODY_MODE_DYNAMIC_LINEAR = 3 --- Constant for linear dynamic bodies. In this mode, a body is dynamic but can not rotate, and only its linear velocity is affected by external forces.
enum BodyParameter:
BODY_PARAM_BOUNCE = 0 --- Constant to set/get a body's bounce factor.
BODY_PARAM_FRICTION = 1 --- Constant to set/get a body's friction.
BODY_PARAM_MASS = 2 --- Constant to set/get a body's mass.
BODY_PARAM_INERTIA = 3 --- Constant to set/get a body's inertia.
BODY_PARAM_CENTER_OF_MASS = 4 --- Constant to set/get a body's center of mass position in the body's local coordinate system.
BODY_PARAM_GRAVITY_SCALE = 5 --- Constant to set/get a body's gravity multiplier.
BODY_PARAM_LINEAR_DAMP_MODE = 6 --- Constant to set/get a body's linear dampening mode. See BodyDampMode for possible values.
BODY_PARAM_ANGULAR_DAMP_MODE = 7 --- Constant to set/get a body's angular dampening mode. See BodyDampMode for possible values.
BODY_PARAM_LINEAR_DAMP = 8 --- Constant to set/get a body's linear dampening factor.
BODY_PARAM_ANGULAR_DAMP = 9 --- Constant to set/get a body's angular dampening factor.
BODY_PARAM_MAX = 10 --- Represents the size of the BodyParameter enum.
enum BodyDampMode:
BODY_DAMP_MODE_COMBINE = 0 --- The body's damping value is added to any value set in areas or the default value.
BODY_DAMP_MODE_REPLACE = 1 --- The body's damping value replaces any value set in areas or the default value.
enum BodyState:
BODY_STATE_TRANSFORM = 0 --- Constant to set/get the current transform matrix of the body.
BODY_STATE_LINEAR_VELOCITY = 1 --- Constant to set/get the current linear velocity of the body.
BODY_STATE_ANGULAR_VELOCITY = 2 --- Constant to set/get the current angular velocity of the body.
BODY_STATE_SLEEPING = 3 --- Constant to sleep/wake up a body, or to get whether it is sleeping.
BODY_STATE_CAN_SLEEP = 4 --- Constant to set/get whether the body can sleep.
enum JointType:
JOINT_TYPE_PIN = 0 --- Constant to create pin joints.
JOINT_TYPE_GROOVE = 1 --- Constant to create groove joints.
JOINT_TYPE_DAMPED_SPRING = 2 --- Constant to create damped spring joints.
JOINT_TYPE_MAX = 3 --- Represents the size of the JointType enum.
enum JointParam:
JOINT_PARAM_BIAS = 0
JOINT_PARAM_MAX_BIAS = 1
JOINT_PARAM_MAX_FORCE = 2
enum DampedSpringParam:
DAMPED_SPRING_REST_LENGTH = 0 --- Sets the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
DAMPED_SPRING_STIFFNESS = 1 --- Sets the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
DAMPED_SPRING_DAMPING = 2 --- Sets the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
enum CCDMode:
CCD_MODE_DISABLED = 0 --- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
CCD_MODE_CAST_RAY = 1 --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
CCD_MODE_CAST_SHAPE = 2 --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
enum AreaBodyStatus:
AREA_BODY_ADDED = 0 --- The value of the first parameter and area callback function receives, when an object enters one of its shapes.
AREA_BODY_REMOVED = 1 --- The value of the first parameter and area callback function receives, when an object exits one of its shapes.
enum ProcessInfo:
INFO_ACTIVE_OBJECTS = 0 --- Constant to get the number of objects that are not sleeping.
INFO_COLLISION_PAIRS = 1 --- Constant to get the number of possible collisions.
INFO_ISLAND_COUNT = 2 --- Constant to get the number of space regions where a collision could occur.
Method Descriptions¶
void area_add_shape ( RID area, RID shape, Transform2D transform=Transform2D(1, 0, 0, 1, 0, 0), bool disabled=false )
Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
Assigns the area to a descendant of Object, so it can exist in the node tree.
void area_clear_shapes ( RID area )
Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
RID area_create ( )
Creates an Area2D. After creating an Area2D with this method, assign it to a space using area_set_space to use the created Area2D in the physics world.
Gets the instance ID of the object the area is assigned to.
Variant area_get_param ( RID area, AreaParameter param ) const
Returns an area parameter value. See AreaParameter for a list of available parameters.
Returns the RID of the nth shape of an area.
Returns the number of shapes assigned to an area.
Transform2D area_get_shape_transform ( RID area, int shape_idx ) const
Returns the transform matrix of a shape within an area.
Returns the space assigned to the area.
Transform2D area_get_transform ( RID area ) const
Returns the transform matrix for an area.
Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
Assigns the area to one or many physics layers.
Sets which physics layers the area will monitor.
Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area.
2: RID of the object that entered/exited the area.
3: Instance ID of the object that entered/exited the area.
4: The shape index of the object that entered/exited the area.
5: The shape index of the area where the object entered/exited.
void area_set_param ( RID area, AreaParameter param, Variant value )
Sets the value for an area parameter. See AreaParameter for a list of available parameters.
Substitutes a given area shape by another. The old shape is selected by its index, the new one by its RID.
Disables a given shape in an area.
void area_set_shape_transform ( RID area, int shape_idx, Transform2D transform )
Sets the transform matrix for an area shape.
Assigns a space to the area.
void area_set_transform ( RID area, Transform2D transform )
Sets the transform matrix for an area.
Adds a body to the list of bodies exempt from collisions.
Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with body_set_constant_force(body, Vector2(0, 0)).
This is equivalent to using body_add_constant_force at the body's center of mass.
Adds a constant positioned force to the body that keeps being applied over time until cleared with body_set_constant_force(body, Vector2(0, 0)).
position is the offset from the body origin in global coordinates.
Adds a constant rotational force without affecting position that keeps being applied over time until cleared with body_set_constant_torque(body, 0).
void body_add_shape ( RID body, RID shape, Transform2D transform=Transform2D(1, 0, 0, 1, 0, 0), bool disabled=false )
Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
This is equivalent to using body_apply_force at the body's center of mass.
Applies a directional impulse without affecting rotation.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
This is equivalent to using body_apply_impulse at the body's center of mass.
Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
position is the offset from the body origin in global coordinates.
Applies a positioned impulse to the body.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
position is the offset from the body origin in global coordinates.
Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
Applies a rotational impulse to the body without affecting the position.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
Assigns the area to a descendant of Object, so it can exist in the node tree.
void body_clear_shapes ( RID body )
Removes all shapes from a body.
RID body_create ( )
Creates a physics body.
Returns the physics layer or layers a body belongs to.
Returns the physics layer or layers a body can collide with.
Returns the body's total constant positional forces applied during each physics update.
See body_add_constant_force and body_add_constant_central_force.
Returns the body's total constant rotational forces applied during each physics update.
Returns the continuous collision detection mode.
PhysicsDirectBodyState2D body_get_direct_state ( RID body )
Returns the PhysicsDirectBodyState2D of the body. Returns null if the body is destroyed or removed from the physics space.
Returns the maximum contacts that can be reported. See body_set_max_contacts_reported.
Returns the body mode.
Gets the instance ID of the object the area is assigned to.
Variant body_get_param ( RID body, BodyParameter param ) const
Returns the value of a body parameter. See BodyParameter for a list of available parameters.
Returns the RID of the nth shape of a body.
Returns the number of shapes assigned to a body.
Transform2D body_get_shape_transform ( RID body, int shape_idx ) const
Returns the transform matrix of a body shape.
Returns the RID of the space assigned to a body.
Returns a body state.
Returns whether a body uses a callback function to calculate its own physics (see body_set_force_integration_callback).
Removes a body from the list of bodies exempt from collisions.
Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
void body_reset_mass_properties ( RID body )
Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using body_set_param.
Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
Sets the physics layer or layers a body belongs to.
Sets the physics layer or layers a body can collide with.
Sets the body's total constant positional forces applied during each physics update.
See body_add_constant_force and body_add_constant_central_force.
Sets the body's total constant rotational forces applied during each physics update.
Sets the continuous collision detection mode using one of the CCDMode constants.
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
Sets the function used to calculate physics for an object, if that object allows it (see body_set_omit_force_integration).
The force integration function takes 2 arguments:
state: PhysicsDirectBodyState2D used to retrieve and modify the body's state.
userdata: Optional user data, if it was passed when calling body_set_force_integration_callback.
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
Sets the body mode using one of the BodyMode constants.
Sets whether a body uses a callback function to calculate its own physics (see body_set_force_integration_callback).
void body_set_param ( RID body, BodyParameter param, Variant value )
Sets a body parameter. See BodyParameter for a list of available parameters.
Substitutes a given body shape by another. The old shape is selected by its index, the new one by its RID.
Enables one way collision on body if enable is true.
Disables shape in body if disable is true.
void body_set_shape_transform ( RID body, int shape_idx, Transform2D transform )
Sets the transform matrix for a body shape.
Assigns a space to the body (see space_create).
Sets a body state using one of the BodyState constants.
Note that the method doesn't take effect immediately. The state will change on the next physics frame.
bool body_test_motion ( RID body, PhysicsTestMotionParameters2D parameters, PhysicsTestMotionResult2D result=null )
Returns true if a collision would result from moving along a motion vector from a given point in space. PhysicsTestMotionParameters2D is passed to set motion parameters. PhysicsTestMotionResult2D can be passed to return additional information.
RID capsule_shape_create ( )
RID circle_shape_create ( )
RID concave_polygon_shape_create ( )
RID convex_polygon_shape_create ( )
float damped_spring_joint_get_param ( RID joint, DampedSpringParam param ) const
Returns the value of a damped spring joint parameter. See DampedSpringParam for a list of available parameters.
void damped_spring_joint_set_param ( RID joint, DampedSpringParam param, float value )
Sets a damped spring joint parameter. See DampedSpringParam for a list of available parameters.
void free_rid ( RID rid )
Destroys any of the objects created by PhysicsServer2D. If the RID passed is not one of the objects that can be created by PhysicsServer2D, an error will be sent to the console.
int get_process_info ( ProcessInfo process_info )
Returns information about the current state of the 2D physics engine. See ProcessInfo for a list of available states.
void joint_clear ( RID joint )
RID joint_create ( )
float joint_get_param ( RID joint, JointParam param ) const
Returns the value of a joint parameter.
Returns a joint's type (see JointType).
void joint_make_damped_spring ( RID joint, Vector2 anchor_a, Vector2 anchor_b, RID body_a, RID body_b )
void joint_make_groove ( RID joint, Vector2 groove1_a, Vector2 groove2_a, Vector2 anchor_b, RID body_a, RID body_b )
void joint_set_param ( RID joint, JointParam param, float value )
Sets a joint parameter. See JointParam for a list of available parameters.
RID rectangle_shape_create ( )
RID segment_shape_create ( )
RID separation_ray_shape_create ( )
void set_active ( bool active )
Activates or deactivates the 2D physics engine.
Returns the shape data.
Returns a shape's type (see ShapeType).
Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created shape_get_type.
RID space_create ( )
Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with area_set_space, or to a body with body_set_space.
PhysicsDirectSpaceState2D space_get_direct_state ( RID space )
Returns the state of a space, a PhysicsDirectSpaceState2D. This object can be used to make collision/intersection queries.
float space_get_param ( RID space, SpaceParameter param ) const
Returns the value of a space parameter.
Returns whether the space is active.
Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
void space_set_param ( RID space, SpaceParameter param, float value )
Sets the value for a space parameter. See SpaceParameter for a list of available parameters.
RID world_boundary_shape_create ( )