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.
PhysicsServer3DΒΆ
Inherits: Object
Inherited By: PhysicsServer3DExtension
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ΒΆ
EnumerationsΒΆ
enum JointType:
JointType JOINT_TYPE_PIN = 0
The Joint3D is a PinJoint3D.
JointType JOINT_TYPE_HINGE = 1
The Joint3D is a HingeJoint3D.
JointType JOINT_TYPE_SLIDER = 2
The Joint3D is a SliderJoint3D.
JointType JOINT_TYPE_CONE_TWIST = 3
The Joint3D is a ConeTwistJoint3D.
JointType JOINT_TYPE_6DOF = 4
The Joint3D is a Generic6DOFJoint3D.
JointType JOINT_TYPE_MAX = 5
Represents the size of the JointType enum.
enum PinJointParam:
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.
PinJointParam PIN_JOINT_DAMPING = 1
The strength with which the pinned objects try to stay in velocity relation to each other.
The higher, the stronger.
PinJointParam 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:
HingeJointParam HINGE_JOINT_BIAS = 0
The speed with which the two bodies get pulled together when they move in different directions.
HingeJointParam HINGE_JOINT_LIMIT_UPPER = 1
The maximum rotation across the Hinge.
HingeJointParam HINGE_JOINT_LIMIT_LOWER = 2
The minimum rotation across the Hinge.
HingeJointParam HINGE_JOINT_LIMIT_BIAS = 3
The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
HingeJointParam HINGE_JOINT_LIMIT_SOFTNESS = 4
HingeJointParam HINGE_JOINT_LIMIT_RELAXATION = 5
The lower this value, the more the rotation gets slowed down.
HingeJointParam HINGE_JOINT_MOTOR_TARGET_VELOCITY = 6
Target speed for the motor.
HingeJointParam HINGE_JOINT_MOTOR_MAX_IMPULSE = 7
Maximum acceleration for the motor.
enum HingeJointFlag:
HingeJointFlag HINGE_JOINT_FLAG_USE_LIMIT = 0
If true, the Hinge has a maximum and a minimum rotation.
HingeJointFlag HINGE_JOINT_FLAG_ENABLE_MOTOR = 1
If true, a motor turns the Hinge.
enum SliderJointParam:
SliderJointParam SLIDER_JOINT_LINEAR_LIMIT_UPPER = 0
The maximum difference between the pivot points on their X axis before damping happens.
SliderJointParam SLIDER_JOINT_LINEAR_LIMIT_LOWER = 1
The minimum difference between the pivot points on their X axis before damping happens.
SliderJointParam 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.
SliderJointParam SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION = 3
The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
SliderJointParam SLIDER_JOINT_LINEAR_LIMIT_DAMPING = 4
The amount of damping once the slider limits are surpassed.
SliderJointParam 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.
SliderJointParam SLIDER_JOINT_LINEAR_MOTION_RESTITUTION = 6
The amount of restitution inside the slider limits.
SliderJointParam SLIDER_JOINT_LINEAR_MOTION_DAMPING = 7
The amount of damping inside the slider limits.
SliderJointParam SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS = 8
A factor applied to the movement across axes orthogonal to the slider.
SliderJointParam SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION = 9
The amount of restitution when movement is across axes orthogonal to the slider.
SliderJointParam SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING = 10
The amount of damping when movement is across axes orthogonal to the slider.
SliderJointParam SLIDER_JOINT_ANGULAR_LIMIT_UPPER = 11
The upper limit of rotation in the slider.
SliderJointParam SLIDER_JOINT_ANGULAR_LIMIT_LOWER = 12
The lower limit of rotation in the slider.
SliderJointParam SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS = 13
A factor applied to the all rotation once the limit is surpassed.
SliderJointParam SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION = 14
The amount of restitution of the rotation when the limit is surpassed.
SliderJointParam SLIDER_JOINT_ANGULAR_LIMIT_DAMPING = 15
The amount of damping of the rotation when the limit is surpassed.
SliderJointParam SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS = 16
A factor that gets applied to the all rotation in the limits.
SliderJointParam SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION = 17
The amount of restitution of the rotation in the limits.
SliderJointParam SLIDER_JOINT_ANGULAR_MOTION_DAMPING = 18
The amount of damping of the rotation in the limits.
SliderJointParam SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS = 19
A factor that gets applied to the all rotation across axes orthogonal to the slider.
SliderJointParam SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION = 20
The amount of restitution of the rotation across axes orthogonal to the slider.
SliderJointParam SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING = 21
The amount of damping of the rotation across axes orthogonal to the slider.
SliderJointParam SLIDER_JOINT_MAX = 22
Represents the size of the SliderJointParam enum.
enum ConeTwistJointParam:
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.
ConeTwistJointParam 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.
ConeTwistJointParam CONE_TWIST_JOINT_BIAS = 2
The speed with which the swing or twist will take place.
The higher, the faster.
ConeTwistJointParam 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.
ConeTwistJointParam CONE_TWIST_JOINT_RELAXATION = 4
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
enum G6DOFJointAxisParam:
G6DOFJointAxisParam G6DOF_JOINT_LINEAR_LOWER_LIMIT = 0
The minimum difference between the pivot points' axes.