summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsServer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PhysicsServer.xml')
-rw-r--r--doc/classes/PhysicsServer.xml240
1 files changed, 239 insertions, 1 deletions
diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml
index 145f5a0163..12c1abccc6 100644
--- a/doc/classes/PhysicsServer.xml
+++ b/doc/classes/PhysicsServer.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsServer" inherits="Object" category="Core" version="3.0.alpha.custom_build">
<brief_description>
+ Server interface for low level physics access.
</brief_description>
<description>
+ Everything related to physics in 3D.
</description>
<tutorials>
</tutorials>
@@ -19,6 +21,7 @@
<argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</argument>
<description>
+ 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.
</description>
</method>
<method name="area_attach_object_instance_id">
@@ -29,6 +32,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
+ Assigns the area to a descendant of [Object], so it can exist in the node tree.
</description>
</method>
<method name="area_clear_shapes">
@@ -37,12 +41,14 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
</description>
</method>
<method name="area_create">
<return type="RID">
</return>
<description>
+ Creates an [Area].
</description>
</method>
<method name="area_get_object_instance_id" qualifiers="const">
@@ -51,6 +57,7 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ Gets the instance ID of the object the area is assigned to.
</description>
</method>
<method name="area_get_param" qualifiers="const">
@@ -61,6 +68,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter">
</argument>
<description>
+ Returns an area parameter value. A list of available parameters is on the AREA_PARAM_* constants.
</description>
</method>
<method name="area_get_shape" qualifiers="const">
@@ -71,6 +79,7 @@
<argument index="1" name="shape_idx" type="int">
</argument>
<description>
+ Returns the [RID] of the nth shape of an area.
</description>
</method>
<method name="area_get_shape_count" qualifiers="const">
@@ -79,6 +88,7 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ Returns the number of shapes assigned to an area.
</description>
</method>
<method name="area_get_shape_transform" qualifiers="const">
@@ -89,6 +99,7 @@
<argument index="1" name="shape_idx" type="int">
</argument>
<description>
+ Returns the transform matrix of a shape within an area.
</description>
</method>
<method name="area_get_space" qualifiers="const">
@@ -97,6 +108,7 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ Returns the space assigned to the area.
</description>
</method>
<method name="area_get_space_override_mode" qualifiers="const">
@@ -105,6 +117,7 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ Returns the space override mode for the area.
</description>
</method>
<method name="area_get_transform" qualifiers="const">
@@ -113,6 +126,7 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ Returns the transform matrix for an area.
</description>
</method>
<method name="area_is_ray_pickable" qualifiers="const">
@@ -121,6 +135,7 @@
<argument index="0" name="area" type="RID">
</argument>
<description>
+ If [code]true[/code] area collides with rays.
</description>
</method>
<method name="area_remove_shape">
@@ -131,6 +146,7 @@
<argument index="1" name="shape_idx" type="int">
</argument>
<description>
+ Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
</description>
</method>
<method name="area_set_collision_layer">
@@ -141,6 +157,7 @@
<argument index="1" name="layer" type="int">
</argument>
<description>
+ Assigns the area to one or many physics layers.
</description>
</method>
<method name="area_set_collision_mask">
@@ -151,6 +168,7 @@
<argument index="1" name="mask" type="int">
</argument>
<description>
+ Sets which physics layers the area will monitor.
</description>
</method>
<method name="area_set_monitor_callback">
@@ -163,6 +181,12 @@
<argument index="2" name="method" type="String">
</argument>
<description>
+ Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
+ 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area.
+ 2: [RID] of the object that entered/exited the area.
+ 3: Instance ID of the object that entered/exited the area.
+ 4: The shape index of the object that entered/exited the area.
+ 5: The shape index of the area where the object entered/exited.
</description>
</method>
<method name="area_set_param">
@@ -175,6 +199,7 @@
<argument index="2" name="value" type="Variant">
</argument>
<description>
+ Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants.
</description>
</method>
<method name="area_set_ray_pickable">
@@ -185,6 +210,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
+ Sets object pickable with rays.
</description>
</method>
<method name="area_set_shape">
@@ -197,6 +223,7 @@
<argument index="2" name="shape" type="RID">
</argument>
<description>
+ Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID].
</description>
</method>
<method name="area_set_shape_transform">
@@ -209,6 +236,7 @@
<argument index="2" name="transform" type="Transform">
</argument>
<description>
+ Sets the transform matrix for an area shape.
</description>
</method>
<method name="area_set_space">
@@ -219,6 +247,7 @@
<argument index="1" name="space" type="RID">
</argument>
<description>
+ Assigns a space to the area.
</description>
</method>
<method name="area_set_space_override_mode">
@@ -229,6 +258,7 @@
<argument index="1" name="mode" type="int" enum="PhysicsServer.AreaSpaceOverrideMode">
</argument>
<description>
+ Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*.
</description>
</method>
<method name="area_set_transform">
@@ -239,6 +269,7 @@
<argument index="1" name="transform" type="Transform">
</argument>
<description>
+ Sets the transform matrix for an area.
</description>
</method>
<method name="body_add_collision_exception">
@@ -249,6 +280,7 @@
<argument index="1" name="excepted_body" type="RID">
</argument>
<description>
+ Adds a body to the list of bodies exempt from collisions.
</description>
</method>
<method name="body_add_shape">
@@ -261,6 +293,7 @@
<argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</argument>
<description>
+ 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.
</description>
</method>
<method name="body_apply_impulse">
@@ -273,6 +306,7 @@
<argument index="2" name="impulse" type="Vector3">
</argument>
<description>
+ Gives the body a push at a [code]position[/code] in the direction of the [code]impulse[/code].
</description>
</method>
<method name="body_apply_torque_impulse">
@@ -283,6 +317,7 @@
<argument index="1" name="impulse" type="Vector3">
</argument>
<description>
+ Gives the body a push to rotate it.
</description>
</method>
<method name="body_attach_object_instance_id">
@@ -293,6 +328,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
+ Assigns the area to a descendant of [Object], so it can exist in the node tree.
</description>
</method>
<method name="body_clear_shapes">
@@ -301,6 +337,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Removes all shapes from a body.
</description>
</method>
<method name="body_create">
@@ -311,6 +348,7 @@
<argument index="1" name="init_sleeping" type="bool" default="false">
</argument>
<description>
+ Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
</description>
</method>
<method name="body_get_axis_lock" qualifiers="const">
@@ -319,6 +357,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK*
</description>
</method>
<method name="body_get_collision_layer" qualifiers="const">
@@ -327,6 +366,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns the physics layer or layers a body belongs to.
</description>
</method>
<method name="body_get_collision_mask" qualifiers="const">
@@ -335,6 +375,16 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns the physics layer or layers a body can collide with.
+- </description>
+- </method>
+- <method name="body_get_direct_state">
+- <return type="PhysicsDirectBodyState">
+- </return>
+- <argument index="0" name="body" type="RID">
+- </argument>
+- <description>
+ Returns the [PhysicsDirectBodyState] of the body.
</description>
</method>
<method name="body_get_max_contacts_reported" qualifiers="const">
@@ -343,6 +393,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported].
</description>
</method>
<method name="body_get_mode" qualifiers="const">
@@ -351,6 +402,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns the body mode.
</description>
</method>
<method name="body_get_object_instance_id" qualifiers="const">
@@ -359,6 +411,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Gets the instance ID of the object the area is assigned to.
</description>
</method>
<method name="body_get_param" qualifiers="const">
@@ -369,6 +422,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter">
</argument>
<description>
+ Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM_* constants.
</description>
</method>
<method name="body_get_shape" qualifiers="const">
@@ -379,6 +433,7 @@
<argument index="1" name="shape_idx" type="int">
</argument>
<description>
+ Returns the [RID] of the nth shape of a body.
</description>
</method>
<method name="body_get_shape_count" qualifiers="const">
@@ -387,6 +442,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns the number of shapes assigned to a body.
</description>
</method>
<method name="body_get_shape_transform" qualifiers="const">
@@ -397,6 +453,7 @@
<argument index="1" name="shape_idx" type="int">
</argument>
<description>
+ Returns the transform matrix of a body shape.
</description>
</method>
<method name="body_get_space" qualifiers="const">
@@ -405,6 +462,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns the [RID] of the space assigned to a body.
</description>
</method>
<method name="body_get_state" qualifiers="const">
@@ -415,6 +473,7 @@
<argument index="1" name="state" type="int" enum="PhysicsServer.BodyState">
</argument>
<description>
+ Returns a body state.
</description>
</method>
<method name="body_is_continuous_collision_detection_enabled" qualifiers="const">
@@ -423,6 +482,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ If [code]true[/code] the continuous collision detection mode is enabled.
</description>
</method>
<method name="body_is_omitting_force_integration" qualifiers="const">
@@ -431,6 +491,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
</description>
</method>
<method name="body_is_ray_pickable" qualifiers="const">
@@ -439,6 +500,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
+ If [code]true[/code] the body can be detected by rays
</description>
</method>
<method name="body_remove_collision_exception">
@@ -449,6 +511,8 @@
<argument index="1" name="excepted_body" type="RID">
</argument>
<description>
+ 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.
</description>
</method>
<method name="body_remove_shape">
@@ -459,6 +523,7 @@
<argument index="1" name="shape_idx" type="int">
</argument>
<description>
+ Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
</description>
</method>
<method name="body_set_axis_lock">
@@ -469,6 +534,7 @@
<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock">
</argument>
<description>
+ Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality.
</description>
</method>
<method name="body_set_axis_velocity">
@@ -479,6 +545,7 @@
<argument index="1" name="axis_velocity" type="Vector3">
</argument>
<description>
+ 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.
</description>
</method>
<method name="body_set_collision_layer">
@@ -489,6 +556,7 @@
<argument index="1" name="layer" type="int">
</argument>
<description>
+ Sets the physics layer or layers a body belongs to.
</description>
</method>
<method name="body_set_collision_mask">
@@ -499,6 +567,7 @@
<argument index="1" name="mask" type="int">
</argument>
<description>
+ Sets the physics layer or layers a body can collide with.
</description>
</method>
<method name="body_set_enable_continuous_collision_detection">
@@ -509,6 +578,8 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
+ If [code]true[/code] 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.
</description>
</method>
<method name="body_set_force_integration_callback">
@@ -523,6 +594,7 @@
<argument index="3" name="userdata" type="Variant" default="null">
</argument>
<description>
+ Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]).
</description>
</method>
<method name="body_set_max_contacts_reported">
@@ -533,6 +605,7 @@
<argument index="1" name="amount" type="int">
</argument>
<description>
+ 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.
</description>
</method>
<method name="body_set_mode">
@@ -543,6 +616,7 @@
<argument index="1" name="mode" type="int" enum="PhysicsServer.BodyMode">
</argument>
<description>
+ Sets the body mode, from one of the constants BODY_MODE*.
</description>
</method>
<method name="body_set_omit_force_integration">
@@ -553,6 +627,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
+ Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]).
</description>
</method>
<method name="body_set_param">
@@ -565,6 +640,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
+ Sets a body parameter. A list of available parameters is on the BODY_PARAM_* constants.
</description>
</method>
<method name="body_set_ray_pickable">
@@ -575,6 +651,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
+ Sets the body pickable with rays if [code]enabled[/code] is set.
</description>
</method>
<method name="body_set_shape">
@@ -587,6 +664,7 @@
<argument index="2" name="shape" type="RID">
</argument>
<description>
+ Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID].
</description>
</method>
<method name="body_set_shape_transform">
@@ -599,6 +677,7 @@
<argument index="2" name="transform" type="Transform">
</argument>
<description>
+ Sets the transform matrix for a body shape.
</description>
</method>
<method name="body_set_space">
@@ -609,6 +688,7 @@
<argument index="1" name="space" type="RID">
</argument>
<description>
+ Assigns a space to the body (see [method create_space]).
</description>
</method>
<method name="body_set_state">
@@ -621,6 +701,7 @@
<argument index="2" name="value" type="Variant">
</argument>
<description>
+ Sets a body state (see BODY_STATE* constants).
</description>
</method>
<method name="cone_twist_joint_get_param" qualifiers="const">
@@ -631,6 +712,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.ConeTwistJointParam">
</argument>
<description>
+ Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT* constants).
</description>
</method>
<method name="cone_twist_joint_set_param">
@@ -643,6 +725,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
+ Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT* constants).
</description>
</method>
<method name="free_rid">
@@ -651,6 +734,7 @@
<argument index="0" name="rid" type="RID">
</argument>
<description>
+ Destroys any of the objects created by PhysicsServer. If the [RID] passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console.
</description>
</method>
<method name="generic_6dof_joint_get_flag">
@@ -662,7 +746,8 @@
</argument>
<argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag">
</argument>
- <description>
+ <description>
+ Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants).
</description>
</method>
<method name="generic_6dof_joint_get_param">
@@ -675,6 +760,7 @@
<argument index="2" name="param" type="int" enum="PhysicsServer.G6DOFJointAxisParam">
</argument>
<description>
+ Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT* constants without the G6DOF_JOINT_FLAG*).
</description>
</method>
<method name="generic_6dof_joint_set_flag">
@@ -689,6 +775,7 @@
<argument index="3" name="enable" type="bool">
</argument>
<description>
+ Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants).
</description>
</method>
<method name="generic_6dof_joint_set_param">
@@ -703,6 +790,7 @@
<argument index="3" name="value" type="float">
</argument>
<description>
+ Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT* constants without the G6DOF_JOINT_FLAG*).
</description>
</method>
<method name="get_process_info">
@@ -711,6 +799,7 @@
<argument index="0" name="process_info" type="int" enum="PhysicsServer.ProcessInfo">
</argument>
<description>
+ Returns an Info defined by the [ProcessInfo] input given.
</description>
</method>
<method name="hinge_joint_get_flag" qualifiers="const">
@@ -721,6 +810,7 @@
<argument index="1" name="flag" type="int" enum="PhysicsServer.HingeJointFlag">
</argument>
<description>
+ Gets a hinge_joint flag (see HINGE_JOINT_FLAG* constants).
</description>
</method>
<method name="hinge_joint_get_param" qualifiers="const">
@@ -731,6 +821,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.HingeJointParam">
</argument>
<description>
+ Gets a hinge_joint parameter (see HINGE_JOINT* constants without the HINGE_JOINT_FLAG*).
</description>
</method>
<method name="hinge_joint_set_flag">
@@ -743,6 +834,7 @@
<argument index="2" name="enabled" type="bool">
</argument>
<description>
+ Sets a hinge_joint flag (see HINGE_JOINT_FLAG* constants).
</description>
</method>
<method name="hinge_joint_set_param">
@@ -755,6 +847,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
+ Sets a hinge_joint parameter (see HINGE_JOINT* constants without the HINGE_JOINT_FLAG*).
</description>
</method>
<method name="joint_create_cone_twist">
@@ -769,6 +862,7 @@
<argument index="3" name="local_ref_B" type="Transform">
</argument>
<description>
+ Creates a [ConeTwistJoint].
</description>
</method>
<method name="joint_create_generic_6dof">
@@ -783,6 +877,7 @@
<argument index="3" name="local_ref_B" type="Transform">
</argument>
<description>
+ Creates a [Generic6DOFJoint].
</description>
</method>
<method name="joint_create_hinge">
@@ -797,6 +892,7 @@
<argument index="3" name="hinge_B" type="Transform">
</argument>
<description>
+ Creates a [HingeJoint].
</description>
</method>
<method name="joint_create_pin">
@@ -811,6 +907,7 @@
<argument index="3" name="local_B" type="Vector3">
</argument>
<description>
+ Creates a [PinJoint].
</description>
</method>
<method name="joint_create_slider">
@@ -825,6 +922,7 @@
<argument index="3" name="local_ref_B" type="Transform">
</argument>
<description>
+ Creates a [SliderJoint].
</description>
</method>
<method name="joint_get_solver_priority" qualifiers="const">
@@ -833,6 +931,7 @@
<argument index="0" name="joint" type="RID">
</argument>
<description>
+ Gets the priority value of the Joint.
</description>
</method>
<method name="joint_get_type" qualifiers="const">
@@ -841,6 +940,7 @@
<argument index="0" name="joint" type="RID">
</argument>
<description>
+ Returns the type of the Joint.
</description>
</method>
<method name="joint_set_solver_priority">
@@ -851,6 +951,7 @@
<argument index="1" name="priority" type="int">
</argument>
<description>
+ Sets the priority value of the Joint.
</description>
</method>
<method name="pin_joint_get_local_a" qualifiers="const">
@@ -859,6 +960,7 @@
<argument index="0" name="joint" type="RID">
</argument>
<description>
+ Returns position of the joint in the local space of body a of the joint.
</description>
</method>
<method name="pin_joint_get_local_b" qualifiers="const">
@@ -867,6 +969,7 @@
<argument index="0" name="joint" type="RID">
</argument>
<description>
+ Returns position of the joint in the local space of body b of the joint.
</description>
</method>
<method name="pin_joint_get_param" qualifiers="const">
@@ -877,6 +980,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.PinJointParam">
</argument>
<description>
+ Gets a pin_joint parameter (see PIN_JOINT* constants).
</description>
</method>
<method name="pin_joint_set_local_a">
@@ -887,6 +991,7 @@
<argument index="1" name="local_A" type="Vector3">
</argument>
<description>
+ Sets position of the joint in the local space of body a of the joint.
</description>
</method>
<method name="pin_joint_set_local_b">
@@ -897,6 +1002,7 @@
<argument index="1" name="local_B" type="Vector3">
</argument>
<description>
+ Sets position of the joint in the local space of body b of the joint.
</description>
</method>
<method name="pin_joint_set_param">
@@ -909,6 +1015,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
+ Sets a pin_joint parameter (see PIN_JOINT* constants).
</description>
</method>
<method name="set_active">
@@ -917,6 +1024,7 @@
<argument index="0" name="active" type="bool">
</argument>
<description>
+ Activates or deactivates the 3D physics engine.
</description>
</method>
<method name="shape_create">
@@ -925,6 +1033,7 @@
<argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType">
</argument>
<description>
+ Creates a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape].
</description>
</method>
<method name="shape_get_data" qualifiers="const">
@@ -933,6 +1042,7 @@
<argument index="0" name="shape" type="RID">
</argument>
<description>
+ Returns the shape data.
</description>
</method>
<method name="shape_get_type" qualifiers="const">
@@ -941,6 +1051,7 @@
<argument index="0" name="shape" type="RID">
</argument>
<description>
+ Returns the type of shape (see SHAPE_* constants).
</description>
</method>
<method name="shape_set_data">
@@ -951,6 +1062,7 @@
<argument index="1" name="data" type="Variant">
</argument>
<description>
+ 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].
</description>
</method>
<method name="slider_joint_get_param" qualifiers="const">
@@ -961,6 +1073,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.SliderJointParam">
</argument>
<description>
+ Gets a slider_joint parameter (see SLIDER_JOINT* constants).
</description>
</method>
<method name="slider_joint_set_param">
@@ -973,12 +1086,14 @@
<argument index="2" name="value" type="float">
</argument>
<description>
+ Gets a slider_joint parameter (see SLIDER_JOINT* constants).
</description>
</method>
<method name="space_create">
<return type="RID">
</return>
<description>
+ 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].
</description>
</method>
<method name="space_get_direct_state">
@@ -987,6 +1102,7 @@
<argument index="0" name="space" type="RID">
</argument>
<description>
+ Returns the state of a space, a [PhysicsDirectSpaceState]. This object can be used to make collision/intersection queries.
</description>
</method>
<method name="space_get_param" qualifiers="const">
@@ -997,6 +1113,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.SpaceParameter">
</argument>
<description>
+ Returns the value of a space parameter.
</description>
</method>
<method name="space_is_active" qualifiers="const">
@@ -1005,6 +1122,7 @@
<argument index="0" name="space" type="RID">
</argument>
<description>
+ Returns whether the space is active.
</description>
</method>
<method name="space_set_active">
@@ -1015,6 +1133,7 @@
<argument index="1" name="active" type="bool">
</argument>
<description>
+ Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
</description>
</method>
<method name="space_set_param">
@@ -1027,169 +1146,256 @@
<argument index="2" name="value" type="float">
</argument>
<description>
+ Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants.
</description>
</method>
</methods>
<constants>
<constant name="JOINT_PIN" value="0">
+ The [Joint] is a [PinJoint].
</constant>
<constant name="JOINT_HINGE" value="1">
+ The [Joint] is a [HingeJoint].
</constant>
<constant name="JOINT_SLIDER" value="2">
+ The [Joint] is a [SliderJoint].
</constant>
<constant name="JOINT_CONE_TWIST" value="3">
+ The [Joint] is a [ConeTwistJoint].
</constant>
<constant name="JOINT_6DOF" value="4">
+ The [Joint] is a [Generic6DOFJoint].
</constant>
<constant name="PIN_JOINT_BIAS" value="0">
+ The strength with which the pinned objects try to stay in positional relation to each other.
+ The higher, the stronger.
</constant>
<constant name="PIN_JOINT_DAMPING" value="1">
+ The strength with which the pinned objects try to stay in velocity relation to each other.
+ The higher, the stronger.
</constant>
<constant name="PIN_JOINT_IMPULSE_CLAMP" value="2">
+ If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends.
</constant>
<constant name="HINGE_JOINT_BIAS" value="0">
+ The speed with wich the two bodies get pulled together when they move in different directions.
</constant>
<constant name="HINGE_JOINT_LIMIT_UPPER" value="1">
+ The maximum rotation across the Hinge.
</constant>
<constant name="HINGE_JOINT_LIMIT_LOWER" value="2">
+ The minimum rotation across the Hinge.
</constant>
<constant name="HINGE_JOINT_LIMIT_BIAS" value="3">
+ The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
</constant>
<constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4">
</constant>
<constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5">
+ The lower this value, the more the rotation gets slowed down.
</constant>
<constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6">
+ Target speed for the motor.
</constant>
<constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7">
+ Maximum acceleration for the motor.
</constant>
<constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0">
+ If [code]true[/code] the Hinge has a maximum and a minimum rotation.
</constant>
<constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1">
+ If [code]true[/code] a motor turns the Hinge
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0">
+ The maximum difference between the pivot points on their x-axis before damping happens.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1">
+ The minimum difference between the pivot points on their x-axis before damping happens.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2">
+ A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3">
+ The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4">
+ The amount of damping once the slider limits are surpassed.
</constant>
<constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5">
+ A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement.
</constant>
<constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6">
+ The amount of restitution inside the slider limits.
</constant>
<constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7">
+ The amount of damping inside the slider limits.
</constant>
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8">
+ A factor applied to the movement accross axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9">
+ The amount of restitution when movement is accross axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10">
+ The amount of damping when movement is accross axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11">
+ The upper limit of rotation in the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12">
+ The lower limit of rotation in the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13">
+ A factor applied to the all rotation once the limit is surpassed.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14">
+ The amount of restitution of the rotation when the limit is surpassed.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15">
+ The amount of damping of the rotation when the limit is surpassed.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16">
+ A factor that gets applied to the all rotation in the limits.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17">
+ The amount of restitution of the rotation in the limits.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18">
+ The amount of damping of the rotation in the limits.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19">
+ A factor that gets applied to the all rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20">
+ The amount of restitution of the rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21">
+ The amount of damping of the rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_MAX" value="22">
+ End flag of SLIDER_JOINT_* constants, used internally.
</constant>
<constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0">
+ Swing is rotation from side to side, around the axis perpendicular to the twist axis.
+ The swing span defines, how much rotation will not get corrected allong the swing axis.
+ Could be defined as looseness in the [ConeTwistJoint].
+ If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code].
</constant>
<constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1">
+ Twist is the rotation around the twist axis, this value defined how far the joint can twist.
+ Twist is locked if below 0.05.
</constant>
<constant name="CONE_TWIST_JOINT_BIAS" value="2">
+ The speed with which the swing or twist will take place.
+ The higher, the faster.
</constant>
<constant name="CONE_TWIST_JOINT_SOFTNESS" value="3">
+ The ease with which the Joint twists, if it's too low, it takes more force to twist the joint.
</constant>
<constant name="CONE_TWIST_JOINT_RELAXATION" value="4">
+ Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
</constant>
<constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0">
+ The minimum difference between the pivot points' axes.
</constant>
<constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1">
+ The maximum difference between the pivot points' axes.
</constant>
<constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2">
+ A factor that gets applied to the movement accross the axes. The lower, the slower the movement.
</constant>
<constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3">
+ The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
</constant>
<constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4">
+ The amount of damping that happens at the linear motion across the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5">
+ The minimum rotation in negative direction to break loose and rotate arround the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6">
+ The minimum rotation in positive direction to break loose and rotate arround the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7">
+ A factor that gets multiplied onto all rotations accross the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8">
+ The amount of rotational damping accross the axes. The lower, the more dampening occurs.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9">
+ The amount of rotational restitution accross the axes. The lower, the more restitution occurs.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10">
+ The maximum amount of force that can occur, when rotating arround the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_ERP" value="11">
+ When correcting the crossing of limits in rotation accross the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12">
+ Target speed for the motor at the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13">
+ Maximum acceleration for the motor at the axes.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0">
+ If [code]set[/code] there is linear motion possible within the given limits.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1">
+ If [code]set[/code] there is rotational motion possible.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2">
+ If [code]set[/code] there is a rotational motor across these axes.
</constant>
<constant name="SHAPE_PLANE" value="0">
+ The [Shape] is a [PlaneShape].
</constant>
<constant name="SHAPE_RAY" value="1">
+ The [Shape] is a [RayShape].
</constant>
<constant name="SHAPE_SPHERE" value="2">
+ The [Shape] is a [SphereShape].
</constant>
<constant name="SHAPE_BOX" value="3">
+ The [Shape] is a [BoxShape].
</constant>
<constant name="SHAPE_CAPSULE" value="4">
+ The [Shape] is a [CapsuleShape].
</constant>
<constant name="SHAPE_CONVEX_POLYGON" value="5">
+ The [Shape] is a [ConvexPolygonShape].
</constant>
<constant name="SHAPE_CONCAVE_POLYGON" value="6">
+ The [Shape] is a [ConcavePolygonShape].
</constant>
<constant name="SHAPE_HEIGHTMAP" value="7">
+ The [Shape] is a [HeightMapShape].
</constant>
<constant name="SHAPE_CUSTOM" value="8">
+ This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
</constant>
<constant name="AREA_PARAM_GRAVITY" value="0">
+ Constant to set/get gravity strength in an area.
</constant>
<constant name="AREA_PARAM_GRAVITY_VECTOR" value="1">
+ Constant to set/get gravity vector/center in an area.
</constant>
<constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2">
+ Constant to set/get whether the gravity vector of an area is a direction, or a center point.
</constant>
<constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3">
+ 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.
</constant>
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4">
+ This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
</constant>
<constant name="AREA_PARAM_LINEAR_DAMP" value="5">
+ Constant to set/get the linear dampening factor of an area.
</constant>
<constant name="AREA_PARAM_ANGULAR_DAMP" value="6">
+ Constant to set/get the angular dampening factor of an area.
</constant>
<constant name="AREA_PARAM_PRIORITY" value="7">
+ Constant to set/get the priority (order of processing) of an area.
</constant>
<constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0">
This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
@@ -1207,70 +1413,102 @@
This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
</constant>
<constant name="BODY_MODE_STATIC" value="0">
+ Constant for static bodies.
</constant>
<constant name="BODY_MODE_KINEMATIC" value="1">
+ Constant for kinematic bodies.
</constant>
<constant name="BODY_MODE_RIGID" value="2">
+ Constant for rigid bodies.
</constant>
<constant name="BODY_MODE_CHARACTER" value="3">
+ Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
</constant>
<constant name="BODY_PARAM_BOUNCE" value="0">
+ Constant to set/get a body's bounce factor.
</constant>
<constant name="BODY_PARAM_FRICTION" value="1">
+ Constant to set/get a body's friction.
</constant>
<constant name="BODY_PARAM_MASS" value="2">
+ Constant to set/get a body's mass.
</constant>
<constant name="BODY_PARAM_GRAVITY_SCALE" value="3">
+ Constant to set/get a body's gravity multiplier.
</constant>
<constant name="BODY_PARAM_ANGULAR_DAMP" value="5">
+ Constant to set/get a body's angular dampening factor.
</constant>
<constant name="BODY_PARAM_LINEAR_DAMP" value="4">
+ Constant to set/get a body's linear dampening factor.
</constant>
<constant name="BODY_PARAM_MAX" value="6">
+ This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
</constant>
<constant name="BODY_STATE_TRANSFORM" value="0">
+ Constant to set/get the current transform matrix of the body.
</constant>
<constant name="BODY_STATE_LINEAR_VELOCITY" value="1">
+ Constant to set/get the current linear velocity of the body.
</constant>
<constant name="BODY_STATE_ANGULAR_VELOCITY" value="2">
+ Constant to set/get the current angular velocity of the body.
</constant>
<constant name="BODY_STATE_SLEEPING" value="3">
+ Constant to sleep/wake up a body, or to get whether it is sleeping.
</constant>
<constant name="BODY_STATE_CAN_SLEEP" value="4">
+ Constant to set/get whether the body can sleep.
</constant>
<constant name="AREA_BODY_ADDED" value="0">
+ The value of the first parameter and area callback function receives, when an object enters one of its shapes.
</constant>
<constant name="AREA_BODY_REMOVED" value="1">
+ The value of the first parameter and area callback function receives, when an object exits one of its shapes.
</constant>
<constant name="INFO_ACTIVE_OBJECTS" value="0">
+ Constant to get the number of objects that are not sleeping.
</constant>
<constant name="INFO_COLLISION_PAIRS" value="1">
+ Constant to get the number of possible collisions.
</constant>
<constant name="INFO_ISLAND_COUNT" value="2">
+ Constant to get the number of space regions where a collision could occur.
</constant>
<constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0">
+ Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
</constant>
<constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1">
+ Constant to set/get the maximum distance a shape can be from another before they are considered separated.
</constant>
<constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2">
+ Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
</constant>
<constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3">
+ Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
</constant>
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4">
+ Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
</constant>
<constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5">
+ Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
</constant>
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6">
</constant>
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7">
+ Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
</constant>
<constant name="BODY_AXIS_LOCK_DISABLED" value="0">
+ The [Body] can rotate and move freely.
</constant>
<constant name="BODY_AXIS_LOCK_X" value="1">
+ The [Body] cannot move across x axis can only rotate across x axis.
</constant>
<constant name="BODY_AXIS_LOCK_Y" value="2">
+ The [Body] cannot move across y axis can only rotate across y axis.
</constant>
<constant name="BODY_AXIS_LOCK_Z" value="3">
+ The [Body] cannot move across z axis can only rotate across z axis.
</constant>
</constants>
</class>
generated by cgit v1.2.3 (git 2.25.1) at 2025-02-08 14:40:05 +0000