PhysicsServer3D

Inherits: Object

Server interface for low-level physics access.

Description

PhysicsServer3D is the server responsible for all 3D physics. It can create many kinds of physics objects, but does not insert them on the node tree.

Methods

void

area_add_shape ( RID area, RID shape, Transform3D transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), bool disabled=false )

void

area_attach_object_instance_id ( RID area, int id )

void

area_clear_shapes ( RID area )

RID

area_create ( )

int

area_get_object_instance_id ( RID area ) const

Variant

area_get_param ( RID area, AreaParameter param ) const

RID

area_get_shape ( RID area, int shape_idx ) const

int

area_get_shape_count ( RID area ) const

Transform3D

area_get_shape_transform ( RID area, int shape_idx ) const

RID

area_get_space ( RID area ) const

Transform3D

area_get_transform ( RID area ) const

void

area_remove_shape ( RID area, int shape_idx )

void

area_set_area_monitor_callback ( RID area, Callable callback )

void

area_set_collision_layer ( RID area, int layer )

void

area_set_collision_mask ( RID area, int mask )

void

area_set_monitor_callback ( RID area, Callable callback )

void

area_set_monitorable ( RID area, bool monitorable )

void

area_set_param ( RID area, AreaParameter param, Variant value )

void

area_set_ray_pickable ( RID area, bool enable )

void

area_set_shape ( RID area, int shape_idx, RID shape )

void

area_set_shape_disabled ( RID area, int shape_idx, bool disabled )

void

area_set_shape_transform ( RID area, int shape_idx, Transform3D transform )

void

area_set_space ( RID area, RID space )

void

area_set_transform ( RID area, Transform3D transform )

void

body_add_central_force ( RID body, Vector3 force )

void

body_add_collision_exception ( RID body, RID excepted_body )

void

body_add_force ( RID body, Vector3 force, Vector3 position=Vector3(0, 0, 0) )

void

body_add_shape ( RID body, RID shape, Transform3D transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), bool disabled=false )

void

body_add_torque ( RID body, Vector3 torque )

void

body_apply_central_impulse ( RID body, Vector3 impulse )

void

body_apply_impulse ( RID body, Vector3 impulse, Vector3 position=Vector3(0, 0, 0) )

void

body_apply_torque_impulse ( RID body, Vector3 impulse )

void

body_attach_object_instance_id ( RID body, int id )

void

body_clear_shapes ( RID body )

RID

body_create ( )

int

body_get_collision_layer ( RID body ) const

int

body_get_collision_mask ( RID body ) const

PhysicsDirectBodyState3D

body_get_direct_state ( RID body )

int

body_get_max_contacts_reported ( RID body ) const

BodyMode

body_get_mode ( RID body ) const

int

body_get_object_instance_id ( RID body ) const

Variant

body_get_param ( RID body, BodyParameter param ) const

RID

body_get_shape ( RID body, int shape_idx ) const

int

body_get_shape_count ( RID body ) const

Transform3D

body_get_shape_transform ( RID body, int shape_idx ) const

RID

body_get_space ( RID body ) const

Variant

body_get_state ( RID body, BodyState state ) const

bool

body_is_axis_locked ( RID body, BodyAxis axis ) const

bool

body_is_continuous_collision_detection_enabled ( RID body ) const

bool

body_is_omitting_force_integration ( RID body ) const

void

body_remove_collision_exception ( RID body, RID excepted_body )

void

body_remove_shape ( RID body, int shape_idx )

void

body_reset_mass_properties ( RID body )

void

body_set_axis_lock ( RID body, BodyAxis axis, bool lock )

void

body_set_axis_velocity ( RID body, Vector3 axis_velocity )

void

body_set_collision_layer ( RID body, int layer )

void

body_set_collision_mask ( RID body, int mask )

void

body_set_enable_continuous_collision_detection ( RID body, bool enable )

void

body_set_force_integration_callback ( RID body, Callable callable, Variant userdata=null )

void

body_set_max_contacts_reported ( RID body, int amount )

void

body_set_mode ( RID body, BodyMode mode )

void

body_set_omit_force_integration ( RID body, bool enable )

void

body_set_param ( RID body, BodyParameter param, Variant value )

void

body_set_ray_pickable ( RID body, bool enable )

void

body_set_shape ( RID body, int shape_idx, RID shape )

void

body_set_shape_disabled ( RID body, int shape_idx, bool disabled )

void

body_set_shape_transform ( RID body, int shape_idx, Transform3D transform )

void

body_set_space ( RID body, RID space )

void

body_set_state ( RID body, BodyState state, Variant value )

bool

body_test_motion ( RID body, PhysicsTestMotionParameters3D parameters, PhysicsTestMotionResult3D result=null )

RID

box_shape_create ( )

RID

capsule_shape_create ( )

RID

concave_polygon_shape_create ( )

float

cone_twist_joint_get_param ( RID joint, ConeTwistJointParam param ) const

void

cone_twist_joint_set_param ( RID joint, ConeTwistJointParam param, float value )

RID

convex_polygon_shape_create ( )

RID

custom_shape_create ( )

RID

cylinder_shape_create ( )

void

free_rid ( RID rid )

bool

generic_6dof_joint_get_flag ( RID joint, Vector3.Axis axis, G6DOFJointAxisFlag flag ) const

float

generic_6dof_joint_get_param ( RID joint, Vector3.Axis axis, G6DOFJointAxisParam param ) const

void

generic_6dof_joint_set_flag ( RID joint, Vector3.Axis axis, G6DOFJointAxisFlag flag, bool enable )

void

generic_6dof_joint_set_param ( RID joint, Vector3.Axis axis, G6DOFJointAxisParam param, float value )

int

get_process_info ( ProcessInfo process_info )

RID

heightmap_shape_create ( )

bool

hinge_joint_get_flag ( RID joint, HingeJointFlag flag ) const

float

hinge_joint_get_param ( RID joint, HingeJointParam param ) const

void

hinge_joint_set_flag ( RID joint, HingeJointFlag flag, bool enabled )

void

hinge_joint_set_param ( RID joint, HingeJointParam param, float value )

void

joint_clear ( RID joint )

RID

joint_create ( )

int

joint_get_solver_priority ( RID joint ) const

JointType

joint_get_type ( RID joint ) const

void

joint_make_cone_twist ( RID joint, RID body_A, Transform3D local_ref_A, RID body_B, Transform3D local_ref_B )

void

joint_make_generic_6dof ( RID joint, RID body_A, Transform3D local_ref_A, RID body_B, Transform3D local_ref_B )

void

joint_make_hinge ( RID joint, RID body_A, Transform3D hinge_A, RID body_B, Transform3D hinge_B )

void

joint_make_pin ( RID joint, RID body_A, Vector3 local_A, RID body_B, Vector3 local_B )

void

joint_make_slider ( RID joint, RID body_A, Transform3D local_ref_A, RID body_B, Transform3D local_ref_B )

void

joint_set_solver_priority ( RID joint, int priority )

Vector3

pin_joint_get_local_a ( RID joint ) const

Vector3

pin_joint_get_local_b ( RID joint ) const

float

pin_joint_get_param ( RID joint, PinJointParam param ) const

void

pin_joint_set_local_a ( RID joint, Vector3 local_A )

void

pin_joint_set_local_b ( RID joint, Vector3 local_B )

void

pin_joint_set_param ( RID joint, PinJointParam param, float value )

RID

separation_ray_shape_create ( )

void

set_active ( bool active )

void

set_collision_iterations ( int iterations )

Variant

shape_get_data ( RID shape ) const

ShapeType

shape_get_type ( RID shape ) const

void

shape_set_data ( RID shape, Variant data )

float

slider_joint_get_param ( RID joint, SliderJointParam param ) const

void

slider_joint_set_param ( RID joint, SliderJointParam param, float value )

AABB

soft_body_get_bounds ( RID body ) const

RID

space_create ( )

PhysicsDirectSpaceState3D

space_get_direct_state ( RID space )

float

space_get_param ( RID space, SpaceParameter param ) const

bool

space_is_active ( RID space ) const

void

space_set_active ( RID space, bool active )

void

space_set_param ( RID space, SpaceParameter param, float value )

RID

sphere_shape_create ( )

RID

world_boundary_shape_create ( )

Enumerations

enum JointType:


enum PinJointParam:

  • PIN_JOINT_BIAS = 0 --- The strength with which the pinned objects try to stay in positional relation to each other.

The higher, the stronger.

  • PIN_JOINT_DAMPING = 1 --- The strength with which the pinned objects try to stay in velocity relation to each other.

The higher, the stronger.

  • PIN_JOINT_IMPULSE_CLAMP = 2 --- If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.


enum HingeJointParam:

  • HINGE_JOINT_BIAS = 0 --- The speed with which the two bodies get pulled together when they move in different directions.

  • HINGE_JOINT_LIMIT_UPPER = 1 --- The maximum rotation across the Hinge.

  • HINGE_JOINT_LIMIT_LOWER = 2 --- The minimum rotation across the Hinge.

  • HINGE_JOINT_LIMIT_BIAS = 3 --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected.

  • HINGE_JOINT_LIMIT_SOFTNESS = 4

  • HINGE_JOINT_LIMIT_RELAXATION = 5 --- The lower this value, the more the rotation gets slowed down.

  • HINGE_JOINT_MOTOR_TARGET_VELOCITY = 6 --- Target speed for the motor.

  • HINGE_JOINT_MOTOR_MAX_IMPULSE = 7 --- Maximum acceleration for the motor.


enum HingeJointFlag:

  • HINGE_JOINT_FLAG_USE_LIMIT = 0 --- If true, the Hinge has a maximum and a minimum rotation.

  • HINGE_JOINT_FLAG_ENABLE_MOTOR = 1 --- If true, a motor turns the Hinge.


enum SliderJointParam:

  • SLIDER_JOINT_LINEAR_LIMIT_UPPER = 0 --- The maximum difference between the pivot points on their X axis before damping happens.

  • SLIDER_JOINT_LINEAR_LIMIT_LOWER = 1 --- The minimum difference between the pivot points on their X axis before damping happens.

  • SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS = 2 --- A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.

  • SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION = 3 --- The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.

  • SLIDER_JOINT_LINEAR_LIMIT_DAMPING = 4 --- The amount of damping once the slider limits are surpassed.

  • SLIDER_JOINT_LINEAR_MOTION_SOFTNESS = 5 --- A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.

  • SLIDER_JOINT_LINEAR_MOTION_RESTITUTION = 6 --- The amount of restitution inside the slider limits.

  • SLIDER_JOINT_LINEAR_MOTION_DAMPING = 7 --- The amount of damping inside the slider limits.

  • SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS = 8 --- A factor applied to the movement across axes orthogonal to the slider.

  • SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION = 9 --- The amount of restitution when movement is across axes orthogonal to the slider.

  • SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING = 10 --- The amount of damping when movement is across axes orthogonal to the slider.

  • SLIDER_JOINT_ANGULAR_LIMIT_UPPER = 11 --- The upper limit of rotation in the slider.

  • SLIDER_JOINT_ANGULAR_LIMIT_LOWER = 12 --- The lower limit of rotation in the slider.

  • SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS = 13 --- A factor applied to the all rotation once the limit is surpassed.

  • SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION = 14 --- The amount of restitution of the rotation when the limit is surpassed.

  • SLIDER_JOINT_ANGULAR_LIMIT_DAMPING = 15 --- The amount of damping of the rotation when the limit is surpassed.

  • SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS = 16 --- A factor that gets applied to the all rotation in the limits.

  • SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION = 17 --- The amount of restitution of the rotation in the limits.

  • SLIDER_JOINT_ANGULAR_MOTION_DAMPING = 18 --- The amount of damping of the rotation in the limits.

  • SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS = 19 --- A factor that gets applied to the all rotation across axes orthogonal to the slider.

  • SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION = 20 --- The amount of restitution of the rotation across axes orthogonal to the slider.

  • SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING = 21 --- The amount of damping of the rotation across axes orthogonal to the slider.

  • SLIDER_JOINT_MAX = 22 --- Represents the size of the SliderJointParam enum.


enum ConeTwistJointParam:

  • CONE_TWIST_JOINT_SWING_SPAN = 0 --- Swing is rotation from side to side, around the axis perpendicular to the twist axis.

The swing span defines, how much rotation will not get corrected along the swing axis.

Could be defined as looseness in the ConeTwistJoint3D.

If below 0.05, this behavior is locked.

  • CONE_TWIST_JOINT_TWIST_SPAN = 1 --- Twist is the rotation around the twist axis, this value defined how far the joint can twist.

Twist is locked if below 0.05.

  • CONE_TWIST_JOINT_BIAS = 2 --- The speed with which the swing or twist will take place.

The higher, the faster.

  • CONE_TWIST_JOINT_SOFTNESS = 3 --- The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.

  • CONE_TWIST_JOINT_RELAXATION = 4 --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced.


enum G6DOFJointAxisParam:

  • G6DOF_JOINT_LINEAR_LOWER_LIMIT = 0 --- The minimum difference between the pivot points' axes.

  • G6DOF_JOINT_LINEAR_UPPER_LIMIT = 1 --- The maximum difference between the pivot points' axes.

  • G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS = 2 --- A factor that gets applied to the movement across the axes. The lower, the slower the movement.

  • G6DOF_JOINT_LINEAR_RESTITUTION = 3 --- The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.

  • G6DOF_JOINT_LINEAR_DAMPING = 4 --- The amount of damping that happens at the linear motion across the axes.

  • G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY = 5 --- The velocity that the joint's linear motor will attempt to reach.

  • G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT = 6 --- The maximum force that the linear motor can apply while trying to reach the target velocity.

  • G6DOF_JOINT_ANGULAR_LOWER_LIMIT = 10 --- The minimum rotation in negative direction to break loose and rotate around the axes.

  • G6DOF_JOINT_ANGULAR_UPPER_LIMIT = 11 --- The minimum rotation in positive direction to break loose and rotate around the axes.

  • G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS = 12 --- A factor that gets multiplied onto all rotations across the axes.

  • G6DOF_JOINT_ANGULAR_DAMPING = 13 --- The amount of rotational damping across the axes. The lower, the more dampening occurs.

  • G6DOF_JOINT_ANGULAR_RESTITUTION = 14 --- The amount of rotational restitution across the axes. The lower, the more restitution occurs.

  • G6DOF_JOINT_ANGULAR_FORCE_LIMIT = 15 --- The maximum amount of force that can occur, when rotating around the axes.

  • G6DOF_JOINT_ANGULAR_ERP = 16 --- When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.

  • G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY = 17 --- Target speed for the motor at the axes.

  • G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT = 18 --- Maximum acceleration for the motor at the axes.


enum G6DOFJointAxisFlag:

  • G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT = 0 --- If set there is linear motion possible within the given limits.

  • G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT = 1 --- If set there is rotational motion possible.

  • G6DOF_JOINT_FLAG_ENABLE_MOTOR = 4 --- If set there is a rotational motor across these axes.

  • G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR = 5 --- If set there is a linear motor on this axis that targets a specific velocity.


enum ShapeType:


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.

  • AREA_PARAM_WIND_FORCE_MAGNITUDE = 11 --- Constant to set/get the magnitude of area-specific wind force.

  • AREA_PARAM_WIND_SOURCE = 12 --- Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.

  • AREA_PARAM_WIND_DIRECTION = 13 --- Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.

  • AREA_PARAM_WIND_ATTENUATION_FACTOR = 14 --- Constant to set/get the exponential rate at which wind force decreases with distance from its origin.


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 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.


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.

  • SPACE_PARAM_BODY_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_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD = 3 --- 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 = 4 --- 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 = 5 --- 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_BODY_ANGULAR_VELOCITY_DAMP_RATIO = 6

  • 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.


enum BodyAxis:

  • BODY_AXIS_LINEAR_X = 1

  • BODY_AXIS_LINEAR_Y = 2

  • BODY_AXIS_LINEAR_Z = 4

  • BODY_AXIS_ANGULAR_X = 8

  • BODY_AXIS_ANGULAR_Y = 16

  • BODY_AXIS_ANGULAR_Z = 32

Method Descriptions

  • void area_add_shape ( RID area, RID shape, Transform3D transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 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.


  • void area_attach_object_instance_id ( RID area, int id )

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 Area3D.


  • int area_get_object_instance_id ( RID area ) const

Gets the instance ID of the object the area is assigned to.


Returns an area parameter value. A list of available parameters is on the AreaParameter constants.


  • RID area_get_shape ( RID area, int shape_idx ) const

Returns the RID of the nth shape of an area.


  • int area_get_shape_count ( RID area ) const

Returns the number of shapes assigned to an area.


Returns the transform matrix of a shape within an area.


  • RID area_get_space ( RID area ) const

Returns the space assigned to the area.


Returns the transform matrix for an area.


  • void area_remove_shape ( RID area, int shape_idx )

Removes a shape from an area. It does not delete the shape, so it can be reassigned later.


  • void area_set_area_monitor_callback ( RID area, Callable callback )


  • void area_set_collision_layer ( RID area, int layer )

Assigns the area to one or many physics layers.


  • void area_set_collision_mask ( RID area, int mask )

Sets which physics layers the area will monitor.


  • void area_set_monitor_callback ( RID area, Callable callback )

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_monitorable ( RID area, bool monitorable )


Sets the value for an area parameter. A list of available parameters is on the AreaParameter constants.


  • void area_set_ray_pickable ( RID area, bool enable )

Sets object pickable with rays.


  • void area_set_shape ( RID area, int shape_idx, RID shape )

Substitutes a given area shape by another. The old shape is selected by its index, the new one by its RID.


  • void area_set_shape_disabled ( RID area, int shape_idx, bool disabled )


Sets the transform matrix for an area shape.


  • void area_set_space ( RID area, RID space )

Assigns a space to the area.


Sets the transform matrix for an area.


  • void body_add_central_force ( RID body, Vector3 force )


  • void body_add_collision_exception ( RID body, RID excepted_body )

Adds a body to the list of bodies exempt from collisions.



  • void body_add_shape ( RID body, RID shape, Transform3D transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 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.


  • void body_add_torque ( RID body, Vector3 torque )


  • void body_apply_central_impulse ( RID body, Vector3 impulse )


  • void body_apply_impulse ( RID body, Vector3 impulse, Vector3 position=Vector3(0, 0, 0) )

Gives the body a push at a position in the direction of the impulse.


  • void body_apply_torque_impulse ( RID body, Vector3 impulse )

Gives the body a push to rotate it.


  • void body_attach_object_instance_id ( RID body, int id )

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 ( )


  • int body_get_collision_layer ( RID body ) const

Returns the physics layer or layers a body belongs to.


  • int body_get_collision_mask ( RID body ) const

Returns the physics layer or layers a body can collide with.


Returns the PhysicsDirectBodyState3D of the body. Returns null if the body is destroyed or removed from the physics space.


  • int body_get_max_contacts_reported ( RID body ) const

Returns the maximum contacts that can be reported. See body_set_max_contacts_reported.


Returns the body mode.


  • int body_get_object_instance_id ( RID body ) const

Gets the instance ID of the object the area is assigned to.


Returns the value of a body parameter. A list of available parameters is on the BodyParameter constants.


  • RID body_get_shape ( RID body, int shape_idx ) const

Returns the RID of the nth shape of a body.


  • int body_get_shape_count ( RID body ) const

Returns the number of shapes assigned to a body.


Returns the transform matrix of a body shape.


  • RID body_get_space ( RID body ) const

Returns the RID of the space assigned to a body.


Returns a body state.



  • bool body_is_continuous_collision_detection_enabled ( RID body ) const

If true, the continuous collision detection mode is enabled.


  • bool body_is_omitting_force_integration ( RID body ) const

Returns whether a body uses a callback function to calculate its own physics (see body_set_force_integration_callback).


  • void body_remove_collision_exception ( RID body, RID excepted_body )

Removes a body from the list of bodies exempt from collisions.

Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.


  • void body_remove_shape ( RID body, int shape_idx )

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.



  • void body_set_axis_velocity ( RID body, Vector3 axis_velocity )

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.


  • void body_set_collision_layer ( RID body, int layer )

Sets the physics layer or layers a body belongs to.


  • void body_set_collision_mask ( RID body, int mask )

Sets the physics layer or layers a body can collide with.


  • void body_set_enable_continuous_collision_detection ( RID body, bool enable )

If true, the continuous collision detection mode is enabled.

Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.


  • void body_set_force_integration_callback ( RID body, Callable callable, Variant userdata=null )

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: PhysicsDirectBodyState3D used to retrieve and modify the body's state.

userdata: Optional user data, if it was passed when calling body_set_force_integration_callback.


  • void body_set_max_contacts_reported ( RID body, int amount )

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, from one of the BodyMode constants.


  • void body_set_omit_force_integration ( RID body, bool enable )

Sets whether a body uses a callback function to calculate its own physics (see body_set_force_integration_callback).


Sets a body parameter. A list of available parameters is on the BodyParameter constants.


  • void body_set_ray_pickable ( RID body, bool enable )

Sets the body pickable with rays if enabled is set.


  • void body_set_shape ( RID body, int shape_idx, RID shape )

Substitutes a given body shape by another. The old shape is selected by its index, the new one by its RID.


  • void body_set_shape_disabled ( RID body, int shape_idx, bool disabled )


Sets the transform matrix for a body shape.


  • void body_set_space ( RID body, RID space )

Assigns a space to the body (see space_create).


Sets a body state (see BodyState constants).


Returns true if a collision would result from moving along a motion vector from a given point in space. PhysicsTestMotionParameters3D is passed to set motion parameters. PhysicsTestMotionResult3D can be passed to return additional information.


  • RID box_shape_create ( )


  • RID capsule_shape_create ( )


  • RID concave_polygon_shape_create ( )


Gets a cone_twist_joint parameter (see ConeTwistJointParam constants).


Sets a cone_twist_joint parameter (see ConeTwistJointParam constants).


  • RID convex_polygon_shape_create ( )


  • RID custom_shape_create ( )


  • RID cylinder_shape_create ( )


  • void free_rid ( RID rid )

Destroys any of the objects created by PhysicsServer3D. If the RID passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console.


Gets a generic_6_DOF_joint flag (see G6DOFJointAxisFlag constants).


Gets a generic_6_DOF_joint parameter (see G6DOFJointAxisParam constants).


Sets a generic_6_DOF_joint flag (see G6DOFJointAxisFlag constants).


Sets a generic_6_DOF_joint parameter (see G6DOFJointAxisParam constants).


Returns an Info defined by the ProcessInfo input given.


  • RID heightmap_shape_create ( )


Gets a hinge_joint flag (see HingeJointFlag constants).


Gets a hinge_joint parameter (see HingeJointParam).


Sets a hinge_joint flag (see HingeJointFlag constants).


Sets a hinge_joint parameter (see HingeJointParam constants).


  • void joint_clear ( RID joint )


  • RID joint_create ( )


  • int joint_get_solver_priority ( RID joint ) const

Gets the priority value of the Joint3D.


Returns the type of the Joint3D.







  • void joint_set_solver_priority ( RID joint, int priority )

Sets the priority value of the Joint3D.


  • Vector3 pin_joint_get_local_a ( RID joint ) const

Returns position of the joint in the local space of body a of the joint.


  • Vector3 pin_joint_get_local_b ( RID joint ) const

Returns position of the joint in the local space of body b of the joint.


Gets a pin_joint parameter (see PinJointParam constants).


  • void pin_joint_set_local_a ( RID joint, Vector3 local_A )

Sets position of the joint in the local space of body a of the joint.


  • void pin_joint_set_local_b ( RID joint, Vector3 local_B )

Sets position of the joint in the local space of body b of the joint.


Sets a pin_joint parameter (see PinJointParam constants).


  • RID separation_ray_shape_create ( )


  • void set_active ( bool active )

Activates or deactivates the 3D physics engine.


  • void set_collision_iterations ( int iterations )

Sets the amount of iterations for calculating velocities of colliding bodies. 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. The default value is 8.

Note: Only has an effect when using the default GodotPhysics engine, not the Bullet physics engine.


Returns the shape data.


Returns the type of shape (see ShapeType constants).


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.


Gets a slider_joint parameter (see SliderJointParam constants).


Gets a slider_joint parameter (see SliderJointParam constants).


  • AABB soft_body_get_bounds ( RID body ) const


  • 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.


Returns the state of a space, a PhysicsDirectSpaceState3D. This object can be used to make collision/intersection queries.


Returns the value of a space parameter.


  • bool space_is_active ( RID space ) const

Returns whether the space is active.


  • void space_set_active ( RID space, bool active )

Marks a space as active. It will not have an effect, unless it is assigned to an area or body.


Sets the value for a space parameter. A list of available parameters is on the SpaceParameter constants.