2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-03-30 16:22:57 +00:00
<class name= "PhysicsServer3D" inherits= "Object" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2019-06-21 23:04:47 +00:00
Server interface for low-level physics access.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2020-03-30 16:22:57 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "area_add_shape" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape" type= "RID" />
<argument index= "2" name= "transform" type= "Transform3D" default= "Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" />
<argument index= "3" name= "disabled" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_attach_object_instance_id" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "id" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Assigns the area to a descendant of [Object], so it can exist in the node tree.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_clear_shapes" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2020-03-30 16:22:57 +00:00
Creates an [Area3D].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_object_instance_id" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "area" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Gets the instance ID of the object the area is assigned to.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Variant" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.AreaParameter" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Returns an area parameter value. A list of available parameters is on the [enum AreaParameter] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_shape" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the [RID] of the nth shape of an area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_shape_count" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "area" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the number of shapes assigned to an area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_shape_transform" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Transform3D" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the transform matrix of a shape within an area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_space" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
<argument index= "0" name= "area" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the space assigned to the area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_space_override_mode" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "PhysicsServer3D.AreaSpaceOverrideMode" />
<argument index= "0" name= "area" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the space override mode for the area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_get_transform" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Transform3D" />
<argument index= "0" name= "area" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the transform matrix for an area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_remove_shape" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-28 12:53:15 +00:00
<method name= "area_set_area_monitor_callback" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "receiver" type= "Object" />
<argument index= "2" name= "method" type= "StringName" />
2018-05-28 12:53:15 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "area_set_collision_layer" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "layer" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Assigns the area to one or many physics layers.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_collision_mask" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "mask" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets which physics layers the area will monitor.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_monitor_callback" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "receiver" type= "Object" />
<argument index= "2" name= "method" type= "StringName" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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:
2019-12-06 22:09:20 +00:00
1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-28 12:53:15 +00:00
<method name= "area_set_monitorable" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "monitorable" type= "bool" />
2018-05-28 12:53:15 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "area_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.AreaParameter" />
<argument index= "2" name= "value" type= "Variant" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets the value for an area parameter. A list of available parameters is on the [enum AreaParameter] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_ray_pickable" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets object pickable with rays.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_shape" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
<argument index= "2" name= "shape" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID].
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-04-30 12:23:59 +00:00
<method name= "area_set_shape_disabled" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
<argument index= "2" name= "disabled" type= "bool" />
2019-04-30 12:23:59 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "area_set_shape_transform" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
<argument index= "2" name= "transform" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the transform matrix for an area shape.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_space" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "space" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Assigns a space to the area.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_space_override_mode" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "mode" type= "int" enum= "PhysicsServer3D.AreaSpaceOverrideMode" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets the space override mode for the area. The modes are described in the [enum AreaSpaceOverrideMode] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "area_set_transform" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "area" type= "RID" />
<argument index= "1" name= "transform" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the transform matrix for an area.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-07-26 09:56:21 +00:00
<method name= "body_add_central_force" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "force" type= "Vector3" />
2018-07-26 09:56:21 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "body_add_collision_exception" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "excepted_body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Adds a body to the list of bodies exempt from collisions.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-07-26 09:56:21 +00:00
<method name= "body_add_force" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "force" type= "Vector3" />
<argument index= "2" name= "position" type= "Vector3" default= "Vector3(0, 0, 0)" />
2018-07-26 09:56:21 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "body_add_shape" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape" type= "RID" />
<argument index= "2" name= "transform" type= "Transform3D" default= "Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" />
<argument index= "3" name= "disabled" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-07-26 09:56:21 +00:00
<method name= "body_add_torque" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "torque" type= "Vector3" />
2018-07-26 09:56:21 +00:00
<description >
</description>
</method>
<method name= "body_apply_central_impulse" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "impulse" type= "Vector3" />
2018-07-26 09:56:21 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "body_apply_impulse" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "impulse" type= "Vector3" />
<argument index= "2" name= "position" type= "Vector3" default= "Vector3(0, 0, 0)" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Gives the body a push at a [code]position[/code] in the direction of the [code]impulse[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_apply_torque_impulse" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "impulse" type= "Vector3" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Gives the body a push to rotate it.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_attach_object_instance_id" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "id" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Assigns the area to a descendant of [Object], so it can exist in the node tree.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_clear_shapes" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Removes all shapes from a body.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
<method name= "body_get_collision_layer" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the physics layer or layers a body belongs to.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_collision_mask" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the physics layer or layers a body can collide with.
2017-10-21 10:02:08 +00:00
-
</description>
</method>
<method name= "body_get_direct_state" >
2021-07-30 13:28:05 +00:00
<return type= "PhysicsDirectBodyState3D" />
<argument index= "0" name= "body" type= "RID" />
2017-10-21 10:02:08 +00:00
<description >
2020-03-30 16:22:57 +00:00
Returns the [PhysicsDirectBodyState3D] of the body.
2017-10-11 21:54:43 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "body_get_max_contacts_reported" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_mode" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "PhysicsServer3D.BodyMode" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the body mode.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_object_instance_id" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Gets the instance ID of the object the area is assigned to.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.BodyParameter" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Returns the value of a body parameter. A list of available parameters is on the [enum BodyParameter] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_shape" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the [RID] of the nth shape of a body.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_shape_count" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the number of shapes assigned to a body.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_shape_transform" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Transform3D" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the transform matrix of a body shape.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_space" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the [RID] of the space assigned to a body.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_get_state" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Variant" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "state" type= "int" enum= "PhysicsServer3D.BodyState" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns a body state.
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-12-11 08:32:25 +00:00
<method name= "body_is_axis_locked" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "axis" type= "int" enum= "PhysicsServer3D.BodyAxis" />
2017-12-11 08:32:25 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "body_is_continuous_collision_detection_enabled" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the continuous collision detection mode is enabled.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_is_omitting_force_integration" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_remove_collision_exception" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "excepted_body" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_remove_shape" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_axis_lock" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "axis" type= "int" enum= "PhysicsServer3D.BodyAxis" />
<argument index= "2" name= "lock" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
<method name= "body_set_axis_velocity" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "axis_velocity" type= "Vector3" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_collision_layer" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "layer" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the physics layer or layers a body belongs to.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_collision_mask" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "mask" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the physics layer or layers a body can collide with.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_enable_continuous_collision_detection" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the continuous collision detection mode is enabled.
2017-10-14 10:19:03 +00:00
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_force_integration_callback" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "callable" type= "Callable" />
<argument index= "2" name= "userdata" type= "Variant" default= "null" />
2017-09-12 20:42:36 +00:00
<description >
2018-05-16 16:15:30 +00:00
Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_max_contacts_reported" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "amount" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_mode" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "mode" type= "int" enum= "PhysicsServer3D.BodyMode" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets the body mode, from one of the [enum BodyMode] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_omit_force_integration" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.BodyParameter" />
<argument index= "2" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a body parameter. A list of available parameters is on the [enum BodyParameter] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_ray_pickable" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the body pickable with rays if [code]enabled[/code] is set.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_shape" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
<argument index= "2" name= "shape" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID].
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-04-30 12:23:59 +00:00
<method name= "body_set_shape_disabled" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
<argument index= "2" name= "disabled" type= "bool" />
2019-04-30 12:23:59 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "body_set_shape_transform" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "shape_idx" type= "int" />
<argument index= "2" name= "transform" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the transform matrix for a body shape.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_space" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "space" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2019-01-07 10:46:26 +00:00
Assigns a space to the body (see [method space_create]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "body_set_state" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "state" type= "int" enum= "PhysicsServer3D.BodyState" />
<argument index= "2" name= "value" type= "Variant" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a body state (see [enum BodyState] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-07-03 01:03:44 +00:00
<method name= "body_test_motion" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "body" type= "RID" />
<argument index= "1" name= "from" type= "Transform3D" />
<argument index= "2" name= "motion" type= "Vector3" />
2021-08-10 18:48:19 +00:00
<argument index= "3" name= "margin" type= "float" default= "0.001" />
<argument index= "4" name= "result" type= "PhysicsTestMotionResult3D" default= "null" />
<argument index= "5" name= "exclude" type= "Array" default= "[]" />
2021-07-03 01:03:44 +00:00
<description >
Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [PhysicsTestMotionResult3D] can be passed to return additional information in.
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "box_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
<method name= "capsule_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
<method name= "concave_polygon_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "cone_twist_joint_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.ConeTwistJointParam" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "cone_twist_joint_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.ConeTwistJointParam" />
<argument index= "2" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "convex_polygon_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
<method name= "custom_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
<method name= "cylinder_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "free_rid" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "rid" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2020-03-30 16:22:57 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "generic_6dof_joint_get_flag" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "axis" type= "int" enum= "Vector3.Axis" />
<argument index= "2" name= "flag" type= "int" enum= "PhysicsServer3D.G6DOFJointAxisFlag" />
2017-10-21 10:02:08 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "generic_6dof_joint_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "axis" type= "int" enum= "Vector3.Axis" />
<argument index= "2" name= "param" type= "int" enum= "PhysicsServer3D.G6DOFJointAxisParam" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "generic_6dof_joint_set_flag" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "axis" type= "int" enum= "Vector3.Axis" />
<argument index= "2" name= "flag" type= "int" enum= "PhysicsServer3D.G6DOFJointAxisFlag" />
<argument index= "3" name= "enable" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "generic_6dof_joint_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "axis" type= "int" enum= "Vector3.Axis" />
<argument index= "2" name= "param" type= "int" enum= "PhysicsServer3D.G6DOFJointAxisParam" />
<argument index= "3" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_process_info" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "process_info" type= "int" enum= "PhysicsServer3D.ProcessInfo" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-27 09:44:37 +00:00
Returns an Info defined by the [enum ProcessInfo] input given.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "heightmap_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "hinge_joint_get_flag" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "flag" type= "int" enum= "PhysicsServer3D.HingeJointFlag" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a hinge_joint flag (see [enum HingeJointFlag] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "hinge_joint_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.HingeJointParam" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a hinge_joint parameter (see [enum HingeJointParam]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "hinge_joint_set_flag" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "flag" type= "int" enum= "PhysicsServer3D.HingeJointFlag" />
<argument index= "2" name= "enabled" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a hinge_joint flag (see [enum HingeJointFlag] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "hinge_joint_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.HingeJointParam" />
<argument index= "2" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a hinge_joint parameter (see [enum HingeJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_clear" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
<method name= "joint_get_solver_priority" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
<argument index= "0" name= "joint" type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
Gets the priority value of the Joint3D.
</description>
</method>
<method name= "joint_get_type" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "PhysicsServer3D.JointType" />
<argument index= "0" name= "joint" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2021-02-19 12:35:31 +00:00
Returns the type of the Joint3D.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_make_cone_twist" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "body_A" type= "RID" />
<argument index= "2" name= "local_ref_A" type= "Transform3D" />
<argument index= "3" name= "body_B" type= "RID" />
<argument index= "4" name= "local_ref_B" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_make_generic_6dof" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "body_A" type= "RID" />
<argument index= "2" name= "local_ref_A" type= "Transform3D" />
<argument index= "3" name= "body_B" type= "RID" />
<argument index= "4" name= "local_ref_B" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_make_hinge" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "body_A" type= "RID" />
<argument index= "2" name= "hinge_A" type= "Transform3D" />
<argument index= "3" name= "body_B" type= "RID" />
<argument index= "4" name= "hinge_B" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_make_pin" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "body_A" type= "RID" />
<argument index= "2" name= "local_A" type= "Vector3" />
<argument index= "3" name= "body_B" type= "RID" />
<argument index= "4" name= "local_B" type= "Vector3" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "joint_make_slider" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "body_A" type= "RID" />
<argument index= "2" name= "local_ref_A" type= "Transform3D" />
<argument index= "3" name= "body_B" type= "RID" />
<argument index= "4" name= "local_ref_B" type= "Transform3D" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
<method name= "joint_set_solver_priority" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "priority" type= "int" />
2017-09-12 20:42:36 +00:00
<description >
2020-03-30 16:22:57 +00:00
Sets the priority value of the Joint3D.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pin_joint_get_local_a" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Vector3" />
<argument index= "0" name= "joint" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns position of the joint in the local space of body a of the joint.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pin_joint_get_local_b" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Vector3" />
<argument index= "0" name= "joint" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns position of the joint in the local space of body b of the joint.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pin_joint_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.PinJointParam" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a pin_joint parameter (see [enum PinJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pin_joint_set_local_a" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "local_A" type= "Vector3" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets position of the joint in the local space of body a of the joint.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pin_joint_set_local_b" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "local_B" type= "Vector3" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets position of the joint in the local space of body b of the joint.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pin_joint_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.PinJointParam" />
<argument index= "2" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets a pin_joint parameter (see [enum PinJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "plane_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "set_active" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "active" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2021-02-19 12:35:31 +00:00
Activates or deactivates the 3D physics engine.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-07-07 17:09:15 +00:00
<method name= "set_collision_iterations" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "iterations" type= "int" />
2021-07-07 17:09:15 +00:00
<description >
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 [code]8[/code].
[b]Note:[/b] Only has an effect when using the default GodotPhysics engine, not the Bullet physics engine.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "shape_get_data" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Variant" />
<argument index= "0" name= "shape" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the shape data.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_get_type" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "PhysicsServer3D.ShapeType" />
<argument index= "0" name= "shape" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Returns the type of shape (see [enum ShapeType] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shape_set_data" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "shape" type= "RID" />
<argument index= "1" name= "data" type= "Variant" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "slider_joint_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.SliderJointParam" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a slider_joint parameter (see [enum SliderJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "slider_joint_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "joint" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.SliderJointParam" />
<argument index= "2" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Gets a slider_joint parameter (see [enum SliderJointParam] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-03-25 11:19:51 +00:00
<method name= "soft_body_get_bounds" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "AABB" />
<argument index= "0" name= "body" type= "RID" />
2021-03-25 11:19:51 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "space_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
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 [method area_set_space], or to a body with [method body_set_space].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "space_get_direct_state" >
2021-07-30 13:28:05 +00:00
<return type= "PhysicsDirectSpaceState3D" />
<argument index= "0" name= "space" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2020-03-30 16:22:57 +00:00
Returns the state of a space, a [PhysicsDirectSpaceState3D]. This object can be used to make collision/intersection queries.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "space_get_param" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "space" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.SpaceParameter" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns the value of a space parameter.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "space_is_active" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "space" type= "RID" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Returns whether the space is active.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "space_set_active" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "space" type= "RID" />
<argument index= "1" name= "active" type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-14 10:19:03 +00:00
Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "space_set_param" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "space" type= "RID" />
<argument index= "1" name= "param" type= "int" enum= "PhysicsServer3D.SpaceParameter" />
<argument index= "2" name= "value" type= "float" />
2017-09-12 20:42:36 +00:00
<description >
2019-12-06 22:09:20 +00:00
Sets the value for a space parameter. A list of available parameters is on the [enum SpaceParameter] constants.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-02-19 12:35:31 +00:00
<method name= "sphere_shape_create" >
2021-07-30 13:28:05 +00:00
<return type= "RID" />
2021-02-19 12:35:31 +00:00
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
<constants >
2021-02-19 12:35:31 +00:00
<constant name= "JOINT_TYPE_PIN" value= "0" enum= "JointType" >
2020-03-30 16:22:57 +00:00
The [Joint3D] is a [PinJoint3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-02-19 12:35:31 +00:00
<constant name= "JOINT_TYPE_HINGE" value= "1" enum= "JointType" >
2020-03-30 16:22:57 +00:00
The [Joint3D] is a [HingeJoint3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-02-19 12:35:31 +00:00
<constant name= "JOINT_TYPE_SLIDER" value= "2" enum= "JointType" >
2020-03-30 16:22:57 +00:00
The [Joint3D] is a [SliderJoint3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-02-19 12:35:31 +00:00
<constant name= "JOINT_TYPE_CONE_TWIST" value= "3" enum= "JointType" >
2020-03-30 16:22:57 +00:00
The [Joint3D] is a [ConeTwistJoint3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-02-19 12:35:31 +00:00
<constant name= "JOINT_TYPE_6DOF" value= "4" enum= "JointType" >
2020-03-30 16:22:57 +00:00
The [Joint3D] is a [Generic6DOFJoint3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-02-19 12:35:31 +00:00
<constant name= "JOINT_TYPE_MAX" value= "5" enum= "JointType" >
Represents the size of the [enum JointType] enum.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PIN_JOINT_BIAS" value= "0" enum= "PinJointParam" >
2017-10-14 10:19:03 +00:00
The strength with which the pinned objects try to stay in positional relation to each other.
The higher, the stronger.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PIN_JOINT_DAMPING" value= "1" enum= "PinJointParam" >
2017-10-14 10:19:03 +00:00
The strength with which the pinned objects try to stay in velocity relation to each other.
The higher, the stronger.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PIN_JOINT_IMPULSE_CLAMP" value= "2" enum= "PinJointParam" >
2020-03-30 16:22:57 +00:00
If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_BIAS" value= "0" enum= "HingeJointParam" >
2018-01-18 20:37:17 +00:00
The speed with which the two bodies get pulled together when they move in different directions.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_LIMIT_UPPER" value= "1" enum= "HingeJointParam" >
2017-10-14 10:19:03 +00:00
The maximum rotation across the Hinge.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_LIMIT_LOWER" value= "2" enum= "HingeJointParam" >
2017-10-14 10:19:03 +00:00
The minimum rotation across the Hinge.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_LIMIT_BIAS" value= "3" enum= "HingeJointParam" >
2017-10-14 10:19:03 +00:00
The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_LIMIT_SOFTNESS" value= "4" enum= "HingeJointParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_LIMIT_RELAXATION" value= "5" enum= "HingeJointParam" >
2017-10-14 10:19:03 +00:00
The lower this value, the more the rotation gets slowed down.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_MOTOR_TARGET_VELOCITY" value= "6" enum= "HingeJointParam" >
2017-10-14 10:19:03 +00:00
Target speed for the motor.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_MOTOR_MAX_IMPULSE" value= "7" enum= "HingeJointParam" >
2017-10-14 10:19:03 +00:00
Maximum acceleration for the motor.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_FLAG_USE_LIMIT" value= "0" enum= "HingeJointFlag" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the Hinge has a maximum and a minimum rotation.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "HINGE_JOINT_FLAG_ENABLE_MOTOR" value= "1" enum= "HingeJointFlag" >
2020-01-23 10:14:14 +00:00
If [code]true[/code], a motor turns the Hinge.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_LIMIT_UPPER" value= "0" enum= "SliderJointParam" >
2019-06-21 23:04:47 +00:00
The maximum difference between the pivot points on their X axis before damping happens.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_LIMIT_LOWER" value= "1" enum= "SliderJointParam" >
2019-06-21 23:04:47 +00:00
The minimum difference between the pivot points on their X axis before damping happens.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value= "2" enum= "SliderJointParam" >
2018-01-18 20:37:17 +00:00
A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value= "3" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value= "4" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of damping once the slider limits are surpassed.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value= "5" enum= "SliderJointParam" >
2018-01-18 20:37:17 +00:00
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.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value= "6" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of restitution inside the slider limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_MOTION_DAMPING" value= "7" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of damping inside the slider limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value= "8" enum= "SliderJointParam" >
2018-01-18 20:37:17 +00:00
A factor applied to the movement across axes orthogonal to the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value= "9" enum= "SliderJointParam" >
2018-01-18 20:37:17 +00:00
The amount of restitution when movement is across axes orthogonal to the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value= "10" enum= "SliderJointParam" >
2018-01-18 20:37:17 +00:00
The amount of damping when movement is across axes orthogonal to the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value= "11" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The upper limit of rotation in the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value= "12" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The lower limit of rotation in the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value= "13" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
A factor applied to the all rotation once the limit is surpassed.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value= "14" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of restitution of the rotation when the limit is surpassed.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value= "15" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of damping of the rotation when the limit is surpassed.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value= "16" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
A factor that gets applied to the all rotation in the limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value= "17" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of restitution of the rotation in the limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value= "18" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of damping of the rotation in the limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value= "19" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
A factor that gets applied to the all rotation across axes orthogonal to the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value= "20" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of restitution of the rotation across axes orthogonal to the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value= "21" enum= "SliderJointParam" >
2017-10-14 10:19:03 +00:00
The amount of damping of the rotation across axes orthogonal to the slider.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SLIDER_JOINT_MAX" value= "22" enum= "SliderJointParam" >
2019-06-27 09:10:53 +00:00
Represents the size of the [enum SliderJointParam] enum.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CONE_TWIST_JOINT_SWING_SPAN" value= "0" enum= "ConeTwistJointParam" >
2017-10-14 10:19:03 +00:00
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
2020-03-11 17:59:18 +00:00
The swing span defines, how much rotation will not get corrected along the swing axis.
2020-03-30 16:22:57 +00:00
Could be defined as looseness in the [ConeTwistJoint3D].
2019-06-29 13:24:23 +00:00
If below 0.05, this behavior is locked.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CONE_TWIST_JOINT_TWIST_SPAN" value= "1" enum= "ConeTwistJointParam" >
2017-10-14 10:19:03 +00:00
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CONE_TWIST_JOINT_BIAS" value= "2" enum= "ConeTwistJointParam" >
2017-10-14 10:19:03 +00:00
The speed with which the swing or twist will take place.
The higher, the faster.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CONE_TWIST_JOINT_SOFTNESS" value= "3" enum= "ConeTwistJointParam" >
2020-03-30 16:22:57 +00:00
The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CONE_TWIST_JOINT_RELAXATION" value= "4" enum= "ConeTwistJointParam" >
2017-10-14 10:19:03 +00:00
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_LINEAR_LOWER_LIMIT" value= "0" enum= "G6DOFJointAxisParam" >
2017-10-14 10:19:03 +00:00
The minimum difference between the pivot points' axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_LINEAR_UPPER_LIMIT" value= "1" enum= "G6DOFJointAxisParam" >
2017-10-14 10:19:03 +00:00
The maximum difference between the pivot points' axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value= "2" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
A factor that gets applied to the movement across the axes. The lower, the slower the movement.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_LINEAR_RESTITUTION" value= "3" enum= "G6DOFJointAxisParam" >
2017-10-14 10:19:03 +00:00
The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_LINEAR_DAMPING" value= "4" enum= "G6DOFJointAxisParam" >
2017-10-14 10:19:03 +00:00
The amount of damping that happens at the linear motion across the axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-03-16 12:07:52 +00:00
<constant name= "G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY" value= "5" enum= "G6DOFJointAxisParam" >
The velocity that the joint's linear motor will attempt to reach.
</constant>
<constant name= "G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT" value= "6" enum= "G6DOFJointAxisParam" >
The maximum force that the linear motor can apply while trying to reach the target velocity.
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value= "10" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
The minimum rotation in negative direction to break loose and rotate around the axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value= "11" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
The minimum rotation in positive direction to break loose and rotate around the axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value= "12" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
A factor that gets multiplied onto all rotations across the axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_DAMPING" value= "13" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
The amount of rotational damping across the axes. The lower, the more dampening occurs.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_RESTITUTION" value= "14" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value= "15" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
The maximum amount of force that can occur, when rotating around the axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_ERP" value= "16" enum= "G6DOFJointAxisParam" >
2018-01-18 20:37:17 +00:00
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.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value= "17" enum= "G6DOFJointAxisParam" >
2017-10-14 10:19:03 +00:00
Target speed for the motor at the axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value= "18" enum= "G6DOFJointAxisParam" >
2017-10-14 10:19:03 +00:00
Maximum acceleration for the motor at the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value= "0" enum= "G6DOFJointAxisFlag" >
2017-10-14 10:19:03 +00:00
If [code]set[/code] there is linear motion possible within the given limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value= "1" enum= "G6DOFJointAxisFlag" >
2017-10-14 10:19:03 +00:00
If [code]set[/code] there is rotational motion possible.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_FLAG_ENABLE_MOTOR" value= "4" enum= "G6DOFJointAxisFlag" >
2017-10-14 10:19:03 +00:00
If [code]set[/code] there is a rotational motor across these axes.
2017-09-12 20:42:36 +00:00
</constant>
2018-11-20 08:34:45 +00:00
<constant name= "G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR" value= "5" enum= "G6DOFJointAxisFlag" >
2018-03-16 12:07:52 +00:00
If [code]set[/code] there is a linear motor on this axis that targets a specific velocity.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SHAPE_PLANE" value= "0" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [WorldMarginShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_SPHERE" value= "1" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [SphereShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_BOX" value= "2" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [BoxShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_CAPSULE" value= "3" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [CapsuleShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_CYLINDER" value= "4" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [CylinderShape3D].
2018-06-12 22:53:28 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_CONVEX_POLYGON" value= "5" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [ConvexPolygonShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_CONCAVE_POLYGON" value= "6" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [ConcavePolygonShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_HEIGHTMAP" value= "7" enum= "ShapeType" >
2020-03-30 16:22:57 +00:00
The [Shape3D] is a [HeightMapShape3D].
2017-09-12 20:42:36 +00:00
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_SOFT_BODY" value= "8" enum= "ShapeType" >
2021-03-25 11:19:51 +00:00
The [Shape3D] is a [SoftBody3D].
</constant>
2021-08-10 18:48:19 +00:00
<constant name= "SHAPE_CUSTOM" value= "9" enum= "ShapeType" >
2017-10-14 10:19:03 +00:00
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_GRAVITY" value= "0" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get gravity strength in an area.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_GRAVITY_VECTOR" value= "1" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get gravity vector/center in an area.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_GRAVITY_IS_POINT" value= "2" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get whether the gravity vector of an area is a direction, or a center point.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_GRAVITY_DISTANCE_SCALE" value= "3" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
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.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_GRAVITY_POINT_ATTENUATION" value= "4" enum= "AreaParameter" >
2019-12-06 22:09:20 +00:00
This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE].
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_LINEAR_DAMP" value= "5" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get the linear dampening factor of an area.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_ANGULAR_DAMP" value= "6" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get the angular dampening factor of an area.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_PARAM_PRIORITY" value= "7" enum= "AreaParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get the priority (order of processing) of an area.
2017-09-12 20:42:36 +00:00
</constant>
2021-07-20 04:23:32 +00:00
<constant name= "AREA_PARAM_WIND_FORCE_MAGNITUDE" value= "8" enum= "AreaParameter" >
Constant to set/get the magnitude of area-specific wind force.
</constant>
<constant name= "AREA_PARAM_WIND_SOURCE" value= "9" enum= "AreaParameter" >
Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
</constant>
<constant name= "AREA_PARAM_WIND_DIRECTION" value= "10" enum= "AreaParameter" >
Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
</constant>
<constant name= "AREA_PARAM_WIND_ATTENUATION_FACTOR" value= "11" enum= "AreaParameter" >
Constant to set/get the exponential rate at which wind force decreases with distance from its origin.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_SPACE_OVERRIDE_DISABLED" value= "0" enum= "AreaSpaceOverrideMode" >
2017-09-12 20:42:36 +00:00
This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_SPACE_OVERRIDE_COMBINE" value= "1" enum= "AreaSpaceOverrideMode" >
2017-09-12 20:42:36 +00:00
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.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value= "2" enum= "AreaSpaceOverrideMode" >
2017-09-12 20:42:36 +00:00
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.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_SPACE_OVERRIDE_REPLACE" value= "3" enum= "AreaSpaceOverrideMode" >
2017-09-12 20:42:36 +00:00
This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value= "4" enum= "AreaSpaceOverrideMode" >
2017-09-12 20:42:36 +00:00
This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_MODE_STATIC" value= "0" enum= "BodyMode" >
2021-05-20 01:15:07 +00:00
Constant for static bodies. In this mode, a body can be only moved by user code.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_MODE_KINEMATIC" value= "1" enum= "BodyMode" >
2021-05-20 01:15:07 +00:00
Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
2017-09-12 20:42:36 +00:00
</constant>
2021-05-20 01:15:07 +00:00
<constant name= "BODY_MODE_DYNAMIC" value= "2" enum= "BodyMode" >
Constant for dynamic bodies. In this mode, a body can be pushed by other bodies and has forces applied.
2017-09-12 20:42:36 +00:00
</constant>
2021-05-20 01:15:07 +00:00
<constant name= "BODY_MODE_DYNAMIC_LOCKED" value= "3" enum= "BodyMode" >
Constant for locked dynamic bodies. In this mode, a body is dynamic but can not rotate, and only its linear velocity is affected by external forces.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_BOUNCE" value= "0" enum= "BodyParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get a body's bounce factor.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_FRICTION" value= "1" enum= "BodyParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get a body's friction.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_MASS" value= "2" enum= "BodyParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get a body's mass.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_GRAVITY_SCALE" value= "3" enum= "BodyParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get a body's gravity multiplier.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_LINEAR_DAMP" value= "4" enum= "BodyParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get a body's linear dampening factor.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_ANGULAR_DAMP" value= "5" enum= "BodyParameter" >
2017-10-22 10:56:11 +00:00
Constant to set/get a body's angular dampening factor.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_PARAM_MAX" value= "6" enum= "BodyParameter" >
2019-06-27 09:10:53 +00:00
Represents the size of the [enum BodyParameter] enum.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_STATE_TRANSFORM" value= "0" enum= "BodyState" >
2017-10-14 10:19:03 +00:00
Constant to set/get the current transform matrix of the body.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_STATE_LINEAR_VELOCITY" value= "1" enum= "BodyState" >
2017-10-14 10:19:03 +00:00
Constant to set/get the current linear velocity of the body.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_STATE_ANGULAR_VELOCITY" value= "2" enum= "BodyState" >
2017-10-14 10:19:03 +00:00
Constant to set/get the current angular velocity of the body.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_STATE_SLEEPING" value= "3" enum= "BodyState" >
2017-10-14 10:19:03 +00:00
Constant to sleep/wake up a body, or to get whether it is sleeping.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BODY_STATE_CAN_SLEEP" value= "4" enum= "BodyState" >
2017-10-14 10:19:03 +00:00
Constant to set/get whether the body can sleep.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_BODY_ADDED" value= "0" enum= "AreaBodyStatus" >
2017-10-14 10:19:03 +00:00
The value of the first parameter and area callback function receives, when an object enters one of its shapes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "AREA_BODY_REMOVED" value= "1" enum= "AreaBodyStatus" >
2017-10-14 10:19:03 +00:00
The value of the first parameter and area callback function receives, when an object exits one of its shapes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "INFO_ACTIVE_OBJECTS" value= "0" enum= "ProcessInfo" >
2017-10-14 10:19:03 +00:00
Constant to get the number of objects that are not sleeping.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "INFO_COLLISION_PAIRS" value= "1" enum= "ProcessInfo" >
2017-10-14 10:19:03 +00:00
Constant to get the number of possible collisions.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "INFO_ISLAND_COUNT" value= "2" enum= "ProcessInfo" >
2017-10-14 10:19:03 +00:00
Constant to get the number of space regions where a collision could occur.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value= "0" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_CONTACT_MAX_SEPARATION" value= "1" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get the maximum distance a shape can be from another before they are considered separated.
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value= "2" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value= "3" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
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.
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value= "4" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
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.
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_BODY_TIME_TO_SLEEP" value= "5" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
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.
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value= "6" enum= "SpaceParameter" >
2017-09-15 23:46:14 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value= "7" enum= "SpaceParameter" >
2017-10-14 10:19:03 +00:00
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.
2017-09-15 23:46:14 +00:00
</constant>
2019-02-18 08:35:10 +00:00
<constant name= "SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH" value= "8" enum= "SpaceParameter" >
</constant>
2017-12-11 08:32:25 +00:00
<constant name= "BODY_AXIS_LINEAR_X" value= "1" enum= "BodyAxis" >
</constant>
<constant name= "BODY_AXIS_LINEAR_Y" value= "2" enum= "BodyAxis" >
</constant>
<constant name= "BODY_AXIS_LINEAR_Z" value= "4" enum= "BodyAxis" >
</constant>
<constant name= "BODY_AXIS_ANGULAR_X" value= "8" enum= "BodyAxis" >
</constant>
<constant name= "BODY_AXIS_ANGULAR_Y" value= "16" enum= "BodyAxis" >
</constant>
<constant name= "BODY_AXIS_ANGULAR_Z" value= "32" enum= "BodyAxis" >
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>