Class reference

PhysicsServer3D

Inherits Object

A server interface for low-level 3D physics access.

Description

PhysicsServer3D is the server responsible for all 3D 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 shape such as a sphere, a box, a cylinder, 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 PhysicsServer3D may be created and manipulated independently; they do not have to be tied to nodes in the scene tree. Note: All the 3D 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

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 a 3D area object in the physics server, and returns the RID that identifies it. The default settings for the created area include a collision layer and mask set to 1, and monitorable set to false. Use area_add_shape() to add shapes to it, use area_set_transform() to set its transform, and use area_set_space() to add the area to a space. If you want the area to be detectable use area_set_monitorable().

int area_get_collision_layer(RID area) const

Returns the physics layer or layers an area belongs to.

int area_get_collision_mask(RID area) const

Returns the physics layer or layers an area can contact with.

int area_get_object_instance_id(RID area) const

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

Variant area_get_param(RID area, int param) const

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.

Transform3D area_get_shape_transform(RID area, int shape_idx) const

Returns the transform matrix of a shape within an area.

RID area_get_space(RID area) const

Returns the space assigned to the area.

Transform3D area_get_transform(RID area) const

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)

Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters: 1. an integer status: either AREA_BODY_ADDED or AREA_BODY_REMOVED depending on whether the other area's shape entered or exited the area, 2. an RID area_rid: the RID of the other area that entered or exited the area, 3. an integer instance_id: the ObjectID attached to the other area, 4. an integer area_shape_idx: the index of the shape of the other area that entered or exited the area, 5. an integer self_shape_idx: the index of the shape of the area where the other area entered or exited. By counting (or keeping track of) the shapes that enter and exit, it can be determined if an area (with all its shapes) is entering for the first time or exiting for the last time.

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 area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters: 1. an integer status: either AREA_BODY_ADDED or AREA_BODY_REMOVED depending on whether the other body shape entered or exited the area, 2. an RID body_rid: the RID of the body that entered or exited the area, 3. an integer instance_id: the ObjectID attached to the body, 4. an integer body_shape_idx: the index of the shape of the body that entered or exited the area, 5. an integer self_shape_idx: the index of the shape of the area where the body entered or exited. By counting (or keeping track of) the shapes that enter and exit, it can be determined if a body (with all its shapes) is entering for the first time or exiting for the last time.

void area_set_monitorable(RID area, bool monitorable)

void area_set_param(RID area, int param, Variant value)

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)

void area_set_shape_transform(RID area, int shape_idx, Transform3D transform)

Sets the transform matrix for an area shape.

void area_set_space(RID area, RID space)

Assigns a space to the area.

void area_set_transform(RID area, Transform3D transform)

Sets the transform matrix for an area.

void body_add_collision_exception(RID body, RID excepted_body)

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

void body_add_constant_central_force(RID body, Vector3 force)

Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with body_set_constant_force(body, Vector3(0, 0, 0)). This is equivalent to using body_add_constant_force() at the body's center of mass.

void body_add_constant_force(RID body, Vector3 force, Vector3 position = Vector3(0, 0, 0))

Adds a constant positioned force to the body that keeps being applied over time until cleared with body_set_constant_force(body, Vector3(0, 0, 0)). position is the offset from the body origin in global coordinates.

void body_add_constant_torque(RID body, Vector3 torque)

Adds a constant rotational force without affecting position that keeps being applied over time until cleared with body_set_constant_torque(body, 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)

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_apply_central_force(RID body, Vector3 force)

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.

void body_apply_central_impulse(RID body, Vector3 impulse)

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.

void body_apply_force(RID body, Vector3 force, Vector3 position = Vector3(0, 0, 0))

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.

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

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.

void body_apply_torque(RID body, Vector3 torque)

Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.

void body_apply_torque_impulse(RID body, Vector3 impulse)

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

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

Creates a 3D body object in the physics server, and returns the RID that identifies it. The default settings for the created area include a collision layer and mask set to 1, and body mode set to BODY_MODE_RIGID. Use body_add_shape() to add shapes to it, use body_set_state() to set its transform, and use body_set_space() to add the body to a space.

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.

float body_get_collision_priority(RID body) const

Returns the body's collision priority.

int body_get_mode(RID body) const

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.

Variant body_get_param(RID body, int param) const

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.

Transform3D body_get_shape_transform(RID body, int shape_idx) const

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.

Variant body_get_state(RID body, int state) const

Returns a body state.

bool body_is_axis_locked(RID body, int axis) const

bool body_is_continuous_collision_detection_enabled(RID body) const

If true, the continuous collision detection mode is enabled.

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_lock(RID body, int axis, bool lock)

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_collision_priority(RID body, float priority)

Sets the body's collision priority.

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 body's custom force integration callback function to callable. Use an empty Callable ([code skip-lint]Callable()[/code]) to clear the custom callback. The function callable will be called every physics tick, before the standard force integration (see body_set_omit_force_integration()). It can be used for example to update the body's linear and angular velocity based on contact with other bodies. If userdata is not null, the function callable must take the following two parameters: 1. state: a PhysicsDirectBodyState3D, used to retrieve and modify the body's state, 2. [code skip-lint]userdata[/code]: a Variant; its value will be the userdata passed into this method. If userdata is null, then callable must take only the state parameter.

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 number of contacts reported to a number greater than 0.

void body_set_mode(RID body, int mode)

Sets the body mode.

void body_set_omit_force_integration(RID body, bool enable)

Sets whether the body omits the standard force integration. If enable is true, the body will not automatically use applied forces, torques, and damping to update the body's linear and angular velocity. In this case, body_set_force_integration_callback() can be used to manually update the linear and angular velocity instead. This method is called when the property RigidBody3D.custom_integrator is set.

void body_set_param(RID body, int param, Variant value)

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

void body_set_shape_transform(RID body, int shape_idx, Transform3D transform)

Sets the transform matrix for a body shape.

void body_set_state(RID body, int state, Variant value)

Sets a body state.

void body_set_state_sync_callback(RID body, Callable callable)

Sets the body's state synchronization callback function to callable. Use an empty Callable ([code skip-lint]Callable()[/code]) to clear the callback. The function callable will be called every physics frame, assuming that the body was active during the previous physics tick, and can be used to fetch the latest state from the physics server. The function callable must take the following parameters: 1. state: a PhysicsDirectBodyState3D, used to retrieve the body's state.

RID box_shape_create()

RID capsule_shape_create()

RID concave_polygon_shape_create()

float cone_twist_joint_get_param(RID joint, int param) const

Gets a cone twist joint parameter.

void cone_twist_joint_set_param(RID joint, int param, float value)

Sets a cone twist joint parameter.

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.

bool generic_6dof_joint_get_flag(RID joint, int axis, int flag) const

Returns the value of a generic 6DOF joint flag.

float generic_6dof_joint_get_param(RID joint, int axis, int param) const

Returns the value of a generic 6DOF joint parameter.

void generic_6dof_joint_set_flag(RID joint, int axis, int flag, bool enable)

Sets the value of a given generic 6DOF joint flag.

void generic_6dof_joint_set_param(RID joint, int axis, int param, float value)

Sets the value of a given generic 6DOF joint parameter.

int get_process_info(int process_info)

Returns the value of a physics engine state specified by process_info.

RID heightmap_shape_create()

bool hinge_joint_get_flag(RID joint, int flag) const

Gets a hinge joint flag.

float hinge_joint_get_param(RID joint, int param) const

Gets a hinge joint parameter.

void hinge_joint_set_flag(RID joint, int flag, bool enabled)

Sets a hinge joint flag.

void hinge_joint_set_param(RID joint, int param, float value)

Sets a hinge joint parameter.

void joint_clear(RID joint)

RID joint_create()

void joint_disable_collisions_between_bodies(RID joint, bool disable)

Sets whether the bodies attached to the Joint3D will collide with each other.

int joint_get_solver_priority(RID joint) const

Gets the priority value of the Joint3D.

int joint_get_type(RID joint) const

Returns the type of the Joint3D.

bool joint_is_disabled_collisions_between_bodies(RID joint) const

Returns whether the bodies attached to the Joint3D will collide with each other.

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.

float pin_joint_get_param(RID joint, int param) const

Gets a pin joint parameter.

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.

void pin_joint_set_param(RID joint, int param, float value)

Sets a pin joint parameter.

RID separation_ray_shape_create()

void set_active(bool active)

Activates or deactivates the 3D physics engine.

Variant shape_get_data(RID shape) const

Returns the shape data.

float shape_get_margin(RID shape) const

Returns the collision margin for the shape. Note: This is not used in Redot Physics, so will always return 0.

int shape_get_type(RID shape) const

Returns the type of shape.

void shape_set_data(RID shape, Variant data)

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

void shape_set_margin(RID shape, float margin)

Sets the collision margin for the shape. Note: This is not used in Redot Physics.

float slider_joint_get_param(RID joint, int param) const

Gets a slider joint parameter.

void slider_joint_set_param(RID joint, int param, float value)

Gets a slider joint parameter.

void soft_body_add_collision_exception(RID body, RID body_b)

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

void soft_body_apply_central_force(RID body, Vector3 force)

Distributes and applies a force to all points. A force is time dependent and meant to be applied every physics update.

void soft_body_apply_central_impulse(RID body, Vector3 impulse)

Distributes and applies an impulse to all points. 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).

void soft_body_apply_point_force(RID body, int point_index, Vector3 force)

Applies a force to a point. A force is time dependent and meant to be applied every physics update.

void soft_body_apply_point_impulse(RID body, int point_index, Vector3 impulse)

Applies an impulse to a point. 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).

RID soft_body_create()

Creates a new soft body and returns its internal RID.

AABB soft_body_get_bounds(RID body) const

Returns the bounds of the given soft body in global coordinates.

int soft_body_get_collision_layer(RID body) const

Returns the physics layer or layers that the given soft body belongs to.

int soft_body_get_collision_mask(RID body) const

Returns the physics layer or layers that the given soft body can collide with.

float soft_body_get_damping_coefficient(RID body) const

Returns the damping coefficient of the given soft body.

float soft_body_get_drag_coefficient(RID body) const

Returns the drag coefficient of the given soft body.

float soft_body_get_linear_stiffness(RID body) const

Returns the linear stiffness of the given soft body.

Vector3 soft_body_get_point_global_position(RID body, int point_index) const

Returns the current position of the given soft body point in global coordinates.

float soft_body_get_pressure_coefficient(RID body) const

Returns the pressure coefficient of the given soft body.

float soft_body_get_shrinking_factor(RID body) const

Returns the shrinking factor of the given soft body.

int soft_body_get_simulation_precision(RID body) const

Returns the simulation precision of the given soft body.

RID soft_body_get_space(RID body) const

Returns the RID of the space assigned to the given soft body.

float soft_body_get_total_mass(RID body) const

Returns the total mass assigned to the given soft body.

bool soft_body_is_point_pinned(RID body, int point_index) const

Returns whether the given soft body point is pinned.

void soft_body_move_point(RID body, int point_index, Vector3 global_position)

Moves the given soft body point to a position in global coordinates.

void soft_body_pin_point(RID body, int point_index, bool pin)

Pins or unpins the given soft body point based on the value of pin. Note: Pinning a point effectively makes it kinematic, preventing it from being affected by forces, but you can still move it using soft_body_move_point().

void soft_body_remove_all_pinned_points(RID body)

Unpins all points of the given soft body.

void soft_body_remove_collision_exception(RID body, RID body_b)

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

void soft_body_set_collision_layer(RID body, int layer)

Sets the physics layer or layers the given soft body belongs to.

void soft_body_set_collision_mask(RID body, int mask)

Sets the physics layer or layers the given soft body can collide with.

void soft_body_set_damping_coefficient(RID body, float damping_coefficient)

Sets the damping coefficient of the given soft body. Higher values will slow down the body more noticeably when forces are applied.

void soft_body_set_drag_coefficient(RID body, float drag_coefficient)

Sets the drag coefficient of the given soft body. Higher values increase this body's air resistance. Note: This value is currently unused by Redot's default physics implementation.

void soft_body_set_linear_stiffness(RID body, float stiffness)

Sets the linear stiffness of the given soft body. Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between 0.0 and 1.0 (inclusive).

void soft_body_set_mesh(RID body, RID mesh)

Sets the mesh of the given soft body.

void soft_body_set_pressure_coefficient(RID body, float pressure_coefficient)

Sets the pressure coefficient of the given soft body. Simulates pressure build-up from inside this body. Higher values increase the strength of this effect.

void soft_body_set_ray_pickable(RID body, bool enable)

Sets whether the given soft body will be pickable when using object picking.

void soft_body_set_shrinking_factor(RID body, float shrinking_factor)

Sets the shrinking factor of the given soft body.

void soft_body_set_simulation_precision(RID body, int simulation_precision)

Sets the simulation precision of the given soft body. Increasing this value will improve the resulting simulation, but can affect performance. Use with care.

void soft_body_set_space(RID body, RID space)

Assigns a space to the given soft body (see space_create()).

void soft_body_set_total_mass(RID body, float total_mass)

Sets the total mass for the given soft body.

void soft_body_set_transform(RID body, Transform3D transform)

Sets the global transform of the given soft body.

void soft_body_update_rendering_server(RID body, PhysicsServer3DRenderingServerHandler rendering_server_handler)

Requests that the physics server updates the rendering server with the latest positions of the given soft body's points through the rendering_server_handler interface.

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

float space_get_param(RID space, int param) const

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.

void space_set_param(RID space, int param, float value)

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

RID sphere_shape_create()

RID world_boundary_shape_create()

Constants

JOINT_TYPE_MAX = 5

Enum: JointType

Represents the size of the JointType enum.

PIN_JOINT_BIAS = 0

Enum: PinJointParam

The strength with which the pinned objects try to stay in positional relation to each other. The higher, the stronger.

PIN_JOINT_DAMPING = 1

Enum: PinJointParam

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

Enum: PinJointParam

If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.

HINGE_JOINT_BIAS = 0

Enum: HingeJointParam

The speed with which the two bodies get pulled together when they move in different directions.

HINGE_JOINT_LIMIT_UPPER = 1

Enum: HingeJointParam

The maximum rotation across the Hinge.

HINGE_JOINT_LIMIT_LOWER = 2

Enum: HingeJointParam

The minimum rotation across the Hinge.

HINGE_JOINT_LIMIT_BIAS = 3

Enum: HingeJointParam

The speed with which the rotation across the axis perpendicular to the hinge gets corrected.

HINGE_JOINT_LIMIT_SOFTNESS = 4

Enum: HingeJointParam

HINGE_JOINT_LIMIT_RELAXATION = 5

Enum: HingeJointParam

The lower this value, the more the rotation gets slowed down.

HINGE_JOINT_MOTOR_TARGET_VELOCITY = 6

Enum: HingeJointParam

Target speed for the motor.

HINGE_JOINT_MOTOR_MAX_IMPULSE = 7

Enum: HingeJointParam

Maximum acceleration for the motor.

HINGE_JOINT_FLAG_USE_LIMIT = 0

Enum: HingeJointFlag

If true, the Hinge has a maximum and a minimum rotation.

HINGE_JOINT_FLAG_ENABLE_MOTOR = 1

Enum: HingeJointFlag

If true, a motor turns the Hinge.

SLIDER_JOINT_LINEAR_LIMIT_UPPER = 0

Enum: SliderJointParam

The maximum difference between the pivot points on their X axis before damping happens.

SLIDER_JOINT_LINEAR_LIMIT_LOWER = 1

Enum: SliderJointParam

The minimum difference between the pivot points on their X axis before damping happens.

SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS = 2

Enum: SliderJointParam

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

Enum: SliderJointParam

The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.

SLIDER_JOINT_LINEAR_LIMIT_DAMPING = 4

Enum: SliderJointParam

The amount of damping once the slider limits are surpassed.

SLIDER_JOINT_LINEAR_MOTION_SOFTNESS = 5

Enum: SliderJointParam

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

Enum: SliderJointParam

The amount of restitution inside the slider limits.

SLIDER_JOINT_LINEAR_MOTION_DAMPING = 7

Enum: SliderJointParam

The amount of damping inside the slider limits.

SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS = 8

Enum: SliderJointParam

A factor applied to the movement across axes orthogonal to the slider.

SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION = 9

Enum: SliderJointParam

The amount of restitution when movement is across axes orthogonal to the slider.

SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING = 10

Enum: SliderJointParam

The amount of damping when movement is across axes orthogonal to the slider.

SLIDER_JOINT_ANGULAR_LIMIT_UPPER = 11

Enum: SliderJointParam

The upper limit of rotation in the slider.

SLIDER_JOINT_ANGULAR_LIMIT_LOWER = 12

Enum: SliderJointParam

The lower limit of rotation in the slider.

SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS = 13

Enum: SliderJointParam

A factor applied to the all rotation once the limit is surpassed.

SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION = 14

Enum: SliderJointParam

The amount of restitution of the rotation when the limit is surpassed.

SLIDER_JOINT_ANGULAR_LIMIT_DAMPING = 15

Enum: SliderJointParam

The amount of damping of the rotation when the limit is surpassed.

SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS = 16

Enum: SliderJointParam

A factor that gets applied to the all rotation in the limits.

SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION = 17

Enum: SliderJointParam

The amount of restitution of the rotation in the limits.

SLIDER_JOINT_ANGULAR_MOTION_DAMPING = 18

Enum: SliderJointParam

The amount of damping of the rotation in the limits.

SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS = 19

Enum: SliderJointParam

A factor that gets applied to the all rotation across axes orthogonal to the slider.

SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION = 20

Enum: SliderJointParam

The amount of restitution of the rotation across axes orthogonal to the slider.

SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING = 21

Enum: SliderJointParam

The amount of damping of the rotation across axes orthogonal to the slider.

SLIDER_JOINT_MAX = 22

Enum: SliderJointParam

Represents the size of the SliderJointParam enum.

CONE_TWIST_JOINT_SWING_SPAN = 0

Enum: ConeTwistJointParam

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

Enum: ConeTwistJointParam

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

Enum: ConeTwistJointParam

The speed with which the swing or twist will take place. The higher, the faster.

CONE_TWIST_JOINT_SOFTNESS = 3

Enum: ConeTwistJointParam

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

Enum: ConeTwistJointParam

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

G6DOF_JOINT_LINEAR_LOWER_LIMIT = 0

Enum: G6DOFJointAxisParam

The minimum difference between the pivot points' axes.

G6DOF_JOINT_LINEAR_UPPER_LIMIT = 1

Enum: G6DOFJointAxisParam

The maximum difference between the pivot points' axes.

G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS = 2

Enum: G6DOFJointAxisParam

A factor that gets applied to the movement across the axes. The lower, the slower the movement.

G6DOF_JOINT_LINEAR_RESTITUTION = 3

Enum: G6DOFJointAxisParam

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

G6DOF_JOINT_LINEAR_DAMPING = 4

Enum: G6DOFJointAxisParam

The amount of damping that happens at the linear motion across the axes.

G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY = 5

Enum: G6DOFJointAxisParam

The velocity that the joint's linear motor will attempt to reach.

G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT = 6

Enum: G6DOFJointAxisParam

The maximum force that the linear motor can apply while trying to reach the target velocity.

G6DOF_JOINT_LINEAR_SPRING_STIFFNESS = 7

Enum: G6DOFJointAxisParam

G6DOF_JOINT_LINEAR_SPRING_DAMPING = 8

Enum: G6DOFJointAxisParam

G6DOF_JOINT_LINEAR_SPRING_EQUILIBRIUM_POINT = 9

Enum: G6DOFJointAxisParam

G6DOF_JOINT_ANGULAR_LOWER_LIMIT = 10

Enum: G6DOFJointAxisParam

The minimum rotation in negative direction to break loose and rotate around the axes.

G6DOF_JOINT_ANGULAR_UPPER_LIMIT = 11

Enum: G6DOFJointAxisParam

The minimum rotation in positive direction to break loose and rotate around the axes.

G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS = 12

Enum: G6DOFJointAxisParam

A factor that gets multiplied onto all rotations across the axes.

G6DOF_JOINT_ANGULAR_DAMPING = 13

Enum: G6DOFJointAxisParam

The amount of rotational damping across the axes. The lower, the more damping occurs.

G6DOF_JOINT_ANGULAR_RESTITUTION = 14

Enum: G6DOFJointAxisParam

The amount of rotational restitution across the axes. The lower, the more restitution occurs.

G6DOF_JOINT_ANGULAR_FORCE_LIMIT = 15

Enum: G6DOFJointAxisParam

The maximum amount of force that can occur, when rotating around the axes.

G6DOF_JOINT_ANGULAR_ERP = 16

Enum: G6DOFJointAxisParam

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

Enum: G6DOFJointAxisParam

Target speed for the motor at the axes.

G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT = 18

Enum: G6DOFJointAxisParam

Maximum acceleration for the motor at the axes.

G6DOF_JOINT_ANGULAR_SPRING_STIFFNESS = 19

Enum: G6DOFJointAxisParam

G6DOF_JOINT_ANGULAR_SPRING_DAMPING = 20

Enum: G6DOFJointAxisParam

G6DOF_JOINT_ANGULAR_SPRING_EQUILIBRIUM_POINT = 21

Enum: G6DOFJointAxisParam

G6DOF_JOINT_MAX = 22

Enum: G6DOFJointAxisParam

Represents the size of the G6DOFJointAxisParam enum.

G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT = 0

Enum: G6DOFJointAxisFlag

If set, linear motion is possible within the given limits.

G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT = 1

Enum: G6DOFJointAxisFlag

If set, rotational motion is possible.

G6DOF_JOINT_FLAG_ENABLE_ANGULAR_SPRING = 2

Enum: G6DOFJointAxisFlag

G6DOF_JOINT_FLAG_ENABLE_LINEAR_SPRING = 3

Enum: G6DOFJointAxisFlag

G6DOF_JOINT_FLAG_ENABLE_MOTOR = 4

Enum: G6DOFJointAxisFlag

If set, there is a rotational motor across these axes.

G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR = 5

Enum: G6DOFJointAxisFlag

If set, there is a linear motor on this axis that targets a specific velocity.

G6DOF_JOINT_FLAG_MAX = 6

Enum: G6DOFJointAxisFlag

Represents the size of the G6DOFJointAxisFlag enum.

SHAPE_SOFT_BODY = 9

Enum: ShapeType

The Shape3D is used internally for a soft body. Any attempt to create this kind of shape results in an error.

SHAPE_CUSTOM = 10

Enum: ShapeType

This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.

AREA_PARAM_GRAVITY_OVERRIDE_MODE = 0

Enum: AreaParameter

Constant to set/get gravity override mode in an area. See AreaSpaceOverrideMode for possible values.

AREA_PARAM_GRAVITY = 1

Enum: AreaParameter

Constant to set/get gravity strength in an area.

AREA_PARAM_GRAVITY_VECTOR = 2

Enum: AreaParameter

Constant to set/get gravity vector/center in an area.

AREA_PARAM_GRAVITY_IS_POINT = 3

Enum: AreaParameter

Constant to set/get whether the gravity vector of an area is a direction, or a center point.

AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE = 4

Enum: AreaParameter

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 meters in radius with a surface gravity of 4.0 m/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 meters from the center the gravity will be 1.0 m/s² (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/s² (half the distance, 4x the gravity), and so on. The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance.

AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE = 5

Enum: AreaParameter

Constant to set/get linear damping override mode in an area. See AreaSpaceOverrideMode for possible values.

AREA_PARAM_LINEAR_DAMP = 6

Enum: AreaParameter

Constant to set/get the linear damping factor of an area.

AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE = 7

Enum: AreaParameter

Constant to set/get angular damping override mode in an area. See AreaSpaceOverrideMode for possible values.

AREA_PARAM_ANGULAR_DAMP = 8

Enum: AreaParameter

Constant to set/get the angular damping factor of an area.

AREA_PARAM_PRIORITY = 9

Enum: AreaParameter

Constant to set/get the priority (order of processing) of an area.

AREA_PARAM_WIND_FORCE_MAGNITUDE = 10

Enum: AreaParameter

Constant to set/get the magnitude of area-specific wind force. This wind force only applies to SoftBody3D nodes. Other physics bodies are currently not affected by wind.

AREA_PARAM_WIND_SOURCE = 11

Enum: AreaParameter

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

AREA_PARAM_WIND_DIRECTION = 12

Enum: AreaParameter

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

AREA_PARAM_WIND_ATTENUATION_FACTOR = 13

Enum: AreaParameter

Constant to set/get the exponential rate at which wind force decreases with distance from its origin.

AREA_SPACE_OVERRIDE_DISABLED = 0

Enum: AreaSpaceOverrideMode

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

Enum: AreaSpaceOverrideMode

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

Enum: AreaSpaceOverrideMode

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

Enum: AreaSpaceOverrideMode

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

Enum: AreaSpaceOverrideMode

This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.

BODY_MODE_STATIC = 0

Enum: BodyMode

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

Enum: BodyMode

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_RIGID = 2

Enum: BodyMode

Constant for rigid bodies. In this mode, a body can be pushed by other bodies and has forces applied.

BODY_MODE_RIGID_LINEAR = 3

Enum: BodyMode

Constant for linear rigid bodies. In this mode, a body can not rotate, and only its linear velocity is affected by external forces.

BODY_PARAM_BOUNCE = 0

Enum: BodyParameter

Constant to set/get a body's bounce factor.

BODY_PARAM_FRICTION = 1

Enum: BodyParameter

Constant to set/get a body's friction.

BODY_PARAM_MASS = 2

Enum: BodyParameter

Constant to set/get a body's mass.

BODY_PARAM_INERTIA = 3

Enum: BodyParameter

Constant to set/get a body's inertia.

BODY_PARAM_CENTER_OF_MASS = 4

Enum: BodyParameter

Constant to set/get a body's center of mass position in the body's local coordinate system.

BODY_PARAM_GRAVITY_SCALE = 5

Enum: BodyParameter

Constant to set/get a body's gravity multiplier.

BODY_PARAM_LINEAR_DAMP_MODE = 6

Enum: BodyParameter

Constant to set/get a body's linear damping mode. See BodyDampMode for possible values.

BODY_PARAM_ANGULAR_DAMP_MODE = 7

Enum: BodyParameter

Constant to set/get a body's angular damping mode. See BodyDampMode for possible values.

BODY_PARAM_LINEAR_DAMP = 8

Enum: BodyParameter

Constant to set/get a body's linear damping factor.

BODY_PARAM_ANGULAR_DAMP = 9

Enum: BodyParameter

Constant to set/get a body's angular damping factor.

BODY_PARAM_MAX = 10

Enum: BodyParameter

Represents the size of the BodyParameter enum.

BODY_DAMP_MODE_COMBINE = 0

Enum: BodyDampMode

The body's damping value is added to any value set in areas or the default value.

BODY_DAMP_MODE_REPLACE = 1

Enum: BodyDampMode

The body's damping value replaces any value set in areas or the default value.

BODY_STATE_TRANSFORM = 0

Enum: BodyState

Constant to set/get the current transform matrix of the body.

BODY_STATE_LINEAR_VELOCITY = 1

Enum: BodyState

Constant to set/get the current linear velocity of the body.

BODY_STATE_ANGULAR_VELOCITY = 2

Enum: BodyState

Constant to set/get the current angular velocity of the body.

BODY_STATE_SLEEPING = 3

Enum: BodyState

Constant to sleep/wake up a body, or to get whether it is sleeping.

BODY_STATE_CAN_SLEEP = 4

Enum: BodyState

Constant to set/get whether the body can sleep.

AREA_BODY_ADDED = 0

Enum: AreaBodyStatus

The value of the first parameter and area callback function receives, when an object enters one of its shapes.

AREA_BODY_REMOVED = 1

Enum: AreaBodyStatus

The value of the first parameter and area callback function receives, when an object exits one of its shapes.

INFO_ACTIVE_OBJECTS = 0

Enum: ProcessInfo

Constant to get the number of objects that are not sleeping.

INFO_COLLISION_PAIRS = 1

Enum: ProcessInfo

Constant to get the number of possible collisions.

INFO_ISLAND_COUNT = 2

Enum: ProcessInfo

Constant to get the number of space regions where a collision could occur.

SPACE_PARAM_CONTACT_RECYCLE_RADIUS = 0

Enum: SpaceParameter

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

Enum: SpaceParameter

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

Enum: SpaceParameter

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

Enum: SpaceParameter

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

Enum: SpaceParameter

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

Enum: SpaceParameter

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

Enum: SpaceParameter

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_SOLVER_ITERATIONS = 7

Enum: SpaceParameter

Constant to set/get the number of solver iterations for contacts and constraints. The greater the number of iterations, the more accurate the collisions and constraints will be. However, a greater number of iterations requires more CPU power, which can decrease performance.

BODY_AXIS_LINEAR_X = 1

Enum: BodyAxis

BODY_AXIS_LINEAR_Y = 2

Enum: BodyAxis

BODY_AXIS_LINEAR_Z = 4

Enum: BodyAxis

BODY_AXIS_ANGULAR_X = 8

Enum: BodyAxis

BODY_AXIS_ANGULAR_Y = 16

Enum: BodyAxis

BODY_AXIS_ANGULAR_Z = 32

Enum: BodyAxis

Source revision 5592dc3a7a61
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.