mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
1997 lines
156 KiB
ReStructuredText
1997 lines
156 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3D.xml.
|
|
|
|
.. _class_PhysicsServer3D:
|
|
|
|
PhysicsServer3D
|
|
===============
|
|
|
|
**Inherits:** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`PhysicsServer3DExtension<class_PhysicsServer3DExtension>`
|
|
|
|
Server interface for low-level physics access.
|
|
|
|
Description
|
|
-----------
|
|
|
|
PhysicsServer3D is the server responsible for all 3D physics. It can create many kinds of physics objects, but does not insert them on the node tree.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_add_shape<class_PhysicsServer3D_method_area_add_shape>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_attach_object_instance_id<class_PhysicsServer3D_method_area_attach_object_instance_id>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_clear_shapes<class_PhysicsServer3D_method_area_clear_shapes>` **(** :ref:`RID<class_RID>` area **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`area_create<class_PhysicsServer3D_method_area_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`area_get_object_instance_id<class_PhysicsServer3D_method_area_get_object_instance_id>` **(** :ref:`RID<class_RID>` area **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`area_get_param<class_PhysicsServer3D_method_area_get_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`area_get_shape<class_PhysicsServer3D_method_area_get_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`area_get_shape_count<class_PhysicsServer3D_method_area_get_shape_count>` **(** :ref:`RID<class_RID>` area **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_shape_transform<class_PhysicsServer3D_method_area_get_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`area_get_space<class_PhysicsServer3D_method_area_get_space>` **(** :ref:`RID<class_RID>` area **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform3D<class_Transform3D>` | :ref:`area_get_transform<class_PhysicsServer3D_method_area_get_transform>` **(** :ref:`RID<class_RID>` area **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_remove_shape<class_PhysicsServer3D_method_area_remove_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_area_monitor_callback<class_PhysicsServer3D_method_area_set_area_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_collision_layer<class_PhysicsServer3D_method_area_set_collision_layer>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_collision_mask<class_PhysicsServer3D_method_area_set_collision_mask>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_monitor_callback<class_PhysicsServer3D_method_area_set_monitor_callback>` **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_monitorable<class_PhysicsServer3D_method_area_set_monitorable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_param<class_PhysicsServer3D_method_area_set_param>` **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_ray_pickable<class_PhysicsServer3D_method_area_set_ray_pickable>` **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` enable **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_shape<class_PhysicsServer3D_method_area_set_shape>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_shape_disabled<class_PhysicsServer3D_method_area_set_shape_disabled>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_shape_transform<class_PhysicsServer3D_method_area_set_shape_transform>` **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_space<class_PhysicsServer3D_method_area_set_space>` **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`area_set_transform<class_PhysicsServer3D_method_area_set_transform>` **(** :ref:`RID<class_RID>` area, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_add_collision_exception<class_PhysicsServer3D_method_body_add_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_add_shape<class_PhysicsServer3D_method_body_add_shape>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_apply_central_force<class_PhysicsServer3D_method_body_apply_central_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_apply_central_impulse<class_PhysicsServer3D_method_body_apply_central_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_apply_torque<class_PhysicsServer3D_method_body_apply_torque>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_apply_torque_impulse<class_PhysicsServer3D_method_body_apply_torque_impulse>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_attach_object_instance_id<class_PhysicsServer3D_method_body_attach_object_instance_id>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_clear_shapes<class_PhysicsServer3D_method_body_clear_shapes>` **(** :ref:`RID<class_RID>` body **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`body_create<class_PhysicsServer3D_method_body_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer3D_method_body_get_collision_layer>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer3D_method_body_get_collision_mask>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_force<class_PhysicsServer3D_method_body_get_constant_force>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`body_get_constant_torque<class_PhysicsServer3D_method_body_get_constant_torque>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` | :ref:`body_get_direct_state<class_PhysicsServer3D_method_body_get_direct_state>` **(** :ref:`RID<class_RID>` body **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer3D_method_body_get_max_contacts_reported>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` | :ref:`body_get_mode<class_PhysicsServer3D_method_body_get_mode>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`body_get_object_instance_id<class_PhysicsServer3D_method_body_get_object_instance_id>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`body_get_param<class_PhysicsServer3D_method_body_get_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`body_get_shape<class_PhysicsServer3D_method_body_get_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`body_get_shape_count<class_PhysicsServer3D_method_body_get_shape_count>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform3D<class_Transform3D>` | :ref:`body_get_shape_transform<class_PhysicsServer3D_method_body_get_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`body_get_space<class_PhysicsServer3D_method_body_get_space>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`body_get_state<class_PhysicsServer3D_method_body_get_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`body_is_axis_locked<class_PhysicsServer3D_method_body_is_axis_locked>` **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`body_is_continuous_collision_detection_enabled<class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_PhysicsServer3D_method_body_is_omitting_force_integration>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_remove_collision_exception<class_PhysicsServer3D_method_body_remove_collision_exception>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_remove_shape<class_PhysicsServer3D_method_body_remove_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_reset_mass_properties<class_PhysicsServer3D_method_body_reset_mass_properties>` **(** :ref:`RID<class_RID>` body **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_axis_lock<class_PhysicsServer3D_method_body_set_axis_lock>` **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_axis_velocity<class_PhysicsServer3D_method_body_set_axis_velocity>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` axis_velocity **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_collision_layer<class_PhysicsServer3D_method_body_set_collision_layer>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_collision_mask<class_PhysicsServer3D_method_body_set_collision_mask>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_constant_force<class_PhysicsServer3D_method_body_set_constant_force>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_constant_torque<class_PhysicsServer3D_method_body_set_constant_torque>` **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>` **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_mode<class_PhysicsServer3D_method_body_set_mode>` **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` mode **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_param<class_PhysicsServer3D_method_body_set_param>` **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_ray_pickable<class_PhysicsServer3D_method_body_set_ray_pickable>` **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_shape<class_PhysicsServer3D_method_body_set_shape>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_shape_disabled<class_PhysicsServer3D_method_body_set_shape_disabled>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_shape_transform<class_PhysicsServer3D_method_body_set_shape_transform>` **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>` **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`body_set_state<class_PhysicsServer3D_method_body_set_state>` **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_PhysicsServer3D_method_body_test_motion>` **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>` parameters, :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` result=null **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`box_shape_create<class_PhysicsServer3D_method_box_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`capsule_shape_create<class_PhysicsServer3D_method_capsule_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`concave_polygon_shape_create<class_PhysicsServer3D_method_concave_polygon_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`cone_twist_joint_get_param<class_PhysicsServer3D_method_cone_twist_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`cone_twist_joint_set_param<class_PhysicsServer3D_method_cone_twist_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param, :ref:`float<class_float>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`convex_polygon_shape_create<class_PhysicsServer3D_method_convex_polygon_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`custom_shape_create<class_PhysicsServer3D_method_custom_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`cylinder_shape_create<class_PhysicsServer3D_method_cylinder_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`free_rid<class_PhysicsServer3D_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`generic_6dof_joint_get_flag<class_PhysicsServer3D_method_generic_6dof_joint_get_flag>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`generic_6dof_joint_get_param<class_PhysicsServer3D_method_generic_6dof_joint_get_param>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`generic_6dof_joint_set_flag<class_PhysicsServer3D_method_generic_6dof_joint_set_flag>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag, :ref:`bool<class_bool>` enable **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`generic_6dof_joint_set_param<class_PhysicsServer3D_method_generic_6dof_joint_set_param>` **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param, :ref:`float<class_float>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_process_info<class_PhysicsServer3D_method_get_process_info>` **(** :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` process_info **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`heightmap_shape_create<class_PhysicsServer3D_method_heightmap_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`hinge_joint_get_flag<class_PhysicsServer3D_method_hinge_joint_get_flag>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`hinge_joint_get_param<class_PhysicsServer3D_method_hinge_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`hinge_joint_set_flag<class_PhysicsServer3D_method_hinge_joint_set_flag>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag, :ref:`bool<class_bool>` enabled **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`hinge_joint_set_param<class_PhysicsServer3D_method_hinge_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param, :ref:`float<class_float>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_clear<class_PhysicsServer3D_method_joint_clear>` **(** :ref:`RID<class_RID>` joint **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`joint_create<class_PhysicsServer3D_method_joint_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`joint_get_solver_priority<class_PhysicsServer3D_method_joint_get_solver_priority>` **(** :ref:`RID<class_RID>` joint **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`JointType<enum_PhysicsServer3D_JointType>` | :ref:`joint_get_type<class_PhysicsServer3D_method_joint_get_type>` **(** :ref:`RID<class_RID>` joint **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_make_cone_twist<class_PhysicsServer3D_method_joint_make_cone_twist>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_make_generic_6dof<class_PhysicsServer3D_method_joint_make_generic_6dof>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_make_hinge<class_PhysicsServer3D_method_joint_make_hinge>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` hinge_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` hinge_B **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_make_pin<class_PhysicsServer3D_method_joint_make_pin>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Vector3<class_Vector3>` local_A, :ref:`RID<class_RID>` body_B, :ref:`Vector3<class_Vector3>` local_B **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_make_slider<class_PhysicsServer3D_method_joint_make_slider>` **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`joint_set_solver_priority<class_PhysicsServer3D_method_joint_set_solver_priority>` **(** :ref:`RID<class_RID>` joint, :ref:`int<class_int>` priority **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_a<class_PhysicsServer3D_method_pin_joint_get_local_a>` **(** :ref:`RID<class_RID>` joint **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`pin_joint_get_local_b<class_PhysicsServer3D_method_pin_joint_get_local_b>` **(** :ref:`RID<class_RID>` joint **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`pin_joint_get_param<class_PhysicsServer3D_method_pin_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`pin_joint_set_local_a<class_PhysicsServer3D_method_pin_joint_set_local_a>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_A **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`pin_joint_set_local_b<class_PhysicsServer3D_method_pin_joint_set_local_b>` **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_B **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`pin_joint_set_param<class_PhysicsServer3D_method_pin_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param, :ref:`float<class_float>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`separation_ray_shape_create<class_PhysicsServer3D_method_separation_ray_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_active<class_PhysicsServer3D_method_set_active>` **(** :ref:`bool<class_bool>` active **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`shape_get_data<class_PhysicsServer3D_method_shape_get_data>` **(** :ref:`RID<class_RID>` shape **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` | :ref:`shape_get_type<class_PhysicsServer3D_method_shape_get_type>` **(** :ref:`RID<class_RID>` shape **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`shape_set_data<class_PhysicsServer3D_method_shape_set_data>` **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`slider_joint_get_param<class_PhysicsServer3D_method_slider_joint_get_param>` **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`slider_joint_set_param<class_PhysicsServer3D_method_slider_joint_set_param>` **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param, :ref:`float<class_float>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`AABB<class_AABB>` | :ref:`soft_body_get_bounds<class_PhysicsServer3D_method_soft_body_get_bounds>` **(** :ref:`RID<class_RID>` body **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`space_create<class_PhysicsServer3D_method_space_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`space_get_direct_state<class_PhysicsServer3D_method_space_get_direct_state>` **(** :ref:`RID<class_RID>` space **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`space_get_param<class_PhysicsServer3D_method_space_get_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`space_is_active<class_PhysicsServer3D_method_space_is_active>` **(** :ref:`RID<class_RID>` space **)** |const| |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`space_set_active<class_PhysicsServer3D_method_space_set_active>` **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`space_set_param<class_PhysicsServer3D_method_space_set_param>` **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param, :ref:`float<class_float>` value **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`sphere_shape_create<class_PhysicsServer3D_method_sphere_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`world_boundary_shape_create<class_PhysicsServer3D_method_world_boundary_shape_create>` **(** **)** |
|
|
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_PhysicsServer3D_JointType:
|
|
|
|
.. _class_PhysicsServer3D_constant_JOINT_TYPE_PIN:
|
|
|
|
.. _class_PhysicsServer3D_constant_JOINT_TYPE_HINGE:
|
|
|
|
.. _class_PhysicsServer3D_constant_JOINT_TYPE_SLIDER:
|
|
|
|
.. _class_PhysicsServer3D_constant_JOINT_TYPE_CONE_TWIST:
|
|
|
|
.. _class_PhysicsServer3D_constant_JOINT_TYPE_6DOF:
|
|
|
|
.. _class_PhysicsServer3D_constant_JOINT_TYPE_MAX:
|
|
|
|
enum **JointType**:
|
|
|
|
- **JOINT_TYPE_PIN** = **0** --- The :ref:`Joint3D<class_Joint3D>` is a :ref:`PinJoint3D<class_PinJoint3D>`.
|
|
|
|
- **JOINT_TYPE_HINGE** = **1** --- The :ref:`Joint3D<class_Joint3D>` is a :ref:`HingeJoint3D<class_HingeJoint3D>`.
|
|
|
|
- **JOINT_TYPE_SLIDER** = **2** --- The :ref:`Joint3D<class_Joint3D>` is a :ref:`SliderJoint3D<class_SliderJoint3D>`.
|
|
|
|
- **JOINT_TYPE_CONE_TWIST** = **3** --- The :ref:`Joint3D<class_Joint3D>` is a :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
|
|
|
|
- **JOINT_TYPE_6DOF** = **4** --- The :ref:`Joint3D<class_Joint3D>` is a :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
|
|
|
|
- **JOINT_TYPE_MAX** = **5** --- Represents the size of the :ref:`JointType<enum_PhysicsServer3D_JointType>` enum.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_PinJointParam:
|
|
|
|
.. _class_PhysicsServer3D_constant_PIN_JOINT_BIAS:
|
|
|
|
.. _class_PhysicsServer3D_constant_PIN_JOINT_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_PIN_JOINT_IMPULSE_CLAMP:
|
|
|
|
enum **PinJointParam**:
|
|
|
|
- **PIN_JOINT_BIAS** = **0** --- The strength with which the pinned objects try to stay in positional relation to each other.
|
|
|
|
The higher, the stronger.
|
|
|
|
- **PIN_JOINT_DAMPING** = **1** --- The strength with which the pinned objects try to stay in velocity relation to each other.
|
|
|
|
The higher, the stronger.
|
|
|
|
- **PIN_JOINT_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint3D puts on its ends.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_HingeJointParam:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_BIAS:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_UPPER:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_LOWER:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_BIAS:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_LIMIT_RELAXATION:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_TARGET_VELOCITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_MOTOR_MAX_IMPULSE:
|
|
|
|
enum **HingeJointParam**:
|
|
|
|
- **HINGE_JOINT_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions.
|
|
|
|
- **HINGE_JOINT_LIMIT_UPPER** = **1** --- The maximum rotation across the Hinge.
|
|
|
|
- **HINGE_JOINT_LIMIT_LOWER** = **2** --- The minimum rotation across the Hinge.
|
|
|
|
- **HINGE_JOINT_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
|
|
|
|
- **HINGE_JOINT_LIMIT_SOFTNESS** = **4**
|
|
|
|
- **HINGE_JOINT_LIMIT_RELAXATION** = **5** --- The lower this value, the more the rotation gets slowed down.
|
|
|
|
- **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor.
|
|
|
|
- **HINGE_JOINT_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_HingeJointFlag:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_USE_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_HINGE_JOINT_FLAG_ENABLE_MOTOR:
|
|
|
|
enum **HingeJointFlag**:
|
|
|
|
- **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true``, the Hinge has a maximum and a minimum rotation.
|
|
|
|
- **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true``, a motor turns the Hinge.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_SliderJointParam:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_LOWER:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_LIMIT_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_MOTION_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_UPPER:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_LOWER:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_LIMIT_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_MOTION_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_SLIDER_JOINT_MAX:
|
|
|
|
enum **SliderJointParam**:
|
|
|
|
- **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their X axis before damping happens.
|
|
|
|
- **SLIDER_JOINT_LINEAR_LIMIT_LOWER** = **1** --- The minimum difference between the pivot points on their X axis before damping happens.
|
|
|
|
- **SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
|
|
|
|
- **SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION** = **3** --- The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
|
|
|
|
- **SLIDER_JOINT_LINEAR_LIMIT_DAMPING** = **4** --- The amount of damping once the slider limits are surpassed.
|
|
|
|
- **SLIDER_JOINT_LINEAR_MOTION_SOFTNESS** = **5** --- A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.
|
|
|
|
- **SLIDER_JOINT_LINEAR_MOTION_RESTITUTION** = **6** --- The amount of restitution inside the slider limits.
|
|
|
|
- **SLIDER_JOINT_LINEAR_MOTION_DAMPING** = **7** --- The amount of damping inside the slider limits.
|
|
|
|
- **SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS** = **8** --- A factor applied to the movement across axes orthogonal to the slider.
|
|
|
|
- **SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION** = **9** --- The amount of restitution when movement is across axes orthogonal to the slider.
|
|
|
|
- **SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING** = **10** --- The amount of damping when movement is across axes orthogonal to the slider.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_LIMIT_UPPER** = **11** --- The upper limit of rotation in the slider.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_LIMIT_LOWER** = **12** --- The lower limit of rotation in the slider.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS** = **13** --- A factor applied to the all rotation once the limit is surpassed.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION** = **14** --- The amount of restitution of the rotation when the limit is surpassed.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_LIMIT_DAMPING** = **15** --- The amount of damping of the rotation when the limit is surpassed.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS** = **16** --- A factor that gets applied to the all rotation in the limits.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION** = **17** --- The amount of restitution of the rotation in the limits.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_MOTION_DAMPING** = **18** --- The amount of damping of the rotation in the limits.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS** = **19** --- A factor that gets applied to the all rotation across axes orthogonal to the slider.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION** = **20** --- The amount of restitution of the rotation across axes orthogonal to the slider.
|
|
|
|
- **SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING** = **21** --- The amount of damping of the rotation across axes orthogonal to the slider.
|
|
|
|
- **SLIDER_JOINT_MAX** = **22** --- Represents the size of the :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` enum.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_ConeTwistJointParam:
|
|
|
|
.. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SWING_SPAN:
|
|
|
|
.. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_TWIST_SPAN:
|
|
|
|
.. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_BIAS:
|
|
|
|
.. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_CONE_TWIST_JOINT_RELAXATION:
|
|
|
|
enum **ConeTwistJointParam**:
|
|
|
|
- **CONE_TWIST_JOINT_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis.
|
|
|
|
The swing span defines, how much rotation will not get corrected along the swing axis.
|
|
|
|
Could be defined as looseness in the :ref:`ConeTwistJoint3D<class_ConeTwistJoint3D>`.
|
|
|
|
If below 0.05, this behavior is locked.
|
|
|
|
- **CONE_TWIST_JOINT_TWIST_SPAN** = **1** --- Twist is the rotation around the twist axis, this value defined how far the joint can twist.
|
|
|
|
Twist is locked if below 0.05.
|
|
|
|
- **CONE_TWIST_JOINT_BIAS** = **2** --- The speed with which the swing or twist will take place.
|
|
|
|
The higher, the faster.
|
|
|
|
- **CONE_TWIST_JOINT_SOFTNESS** = **3** --- The ease with which the Joint3D twists, if it's too low, it takes more force to twist the joint.
|
|
|
|
- **CONE_TWIST_JOINT_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_G6DOFJointAxisParam:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_UPPER_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LOWER_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_UPPER_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_DAMPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_RESTITUTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_FORCE_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_ERP:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT:
|
|
|
|
enum **G6DOFJointAxisParam**:
|
|
|
|
- **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes.
|
|
|
|
- **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes.
|
|
|
|
- **G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor that gets applied to the movement across the axes. The lower, the slower the movement.
|
|
|
|
- **G6DOF_JOINT_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
|
|
|
|
- **G6DOF_JOINT_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes.
|
|
|
|
- **G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity that the joint's linear motor will attempt to reach.
|
|
|
|
- **G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force that the linear motor can apply while trying to reach the target velocity.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_LOWER_LIMIT** = **10** --- The minimum rotation in negative direction to break loose and rotate around the axes.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_UPPER_LIMIT** = **11** --- The minimum rotation in positive direction to break loose and rotate around the axes.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS** = **12** --- A factor that gets multiplied onto all rotations across the axes.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_DAMPING** = **13** --- The amount of rotational damping across the axes. The lower, the more dampening occurs.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_RESTITUTION** = **14** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_FORCE_LIMIT** = **15** --- The maximum amount of force that can occur, when rotating around the axes.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_ERP** = **16** --- When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = **17** --- Target speed for the motor at the axes.
|
|
|
|
- **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_G6DOFJointAxisFlag:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_MOTOR:
|
|
|
|
.. _class_PhysicsServer3D_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR:
|
|
|
|
enum **G6DOFJointAxisFlag**:
|
|
|
|
- **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If set, linear motion is possible within the given limits.
|
|
|
|
- **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If set, rotational motion is possible.
|
|
|
|
- **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = **4** --- If set, there is a rotational motor across these axes.
|
|
|
|
- **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = **5** --- If set, there is a linear motor on this axis that targets a specific velocity.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_ShapeType:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_WORLD_BOUNDARY:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_SEPARATION_RAY:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_SPHERE:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_BOX:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_CAPSULE:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_CYLINDER:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_CONVEX_POLYGON:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_CONCAVE_POLYGON:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_HEIGHTMAP:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_SOFT_BODY:
|
|
|
|
.. _class_PhysicsServer3D_constant_SHAPE_CUSTOM:
|
|
|
|
enum **ShapeType**:
|
|
|
|
- **SHAPE_WORLD_BOUNDARY** = **0** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`WorldBoundaryShape3D<class_WorldBoundaryShape3D>`.
|
|
|
|
- **SHAPE_SEPARATION_RAY** = **1** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`SeparationRayShape3D<class_SeparationRayShape3D>`.
|
|
|
|
- **SHAPE_SPHERE** = **2** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`SphereShape3D<class_SphereShape3D>`.
|
|
|
|
- **SHAPE_BOX** = **3** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`BoxShape3D<class_BoxShape3D>`.
|
|
|
|
- **SHAPE_CAPSULE** = **4** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`CapsuleShape3D<class_CapsuleShape3D>`.
|
|
|
|
- **SHAPE_CYLINDER** = **5** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`CylinderShape3D<class_CylinderShape3D>`.
|
|
|
|
- **SHAPE_CONVEX_POLYGON** = **6** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConvexPolygonShape3D<class_ConvexPolygonShape3D>`.
|
|
|
|
- **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`ConcavePolygonShape3D<class_ConcavePolygonShape3D>`.
|
|
|
|
- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape3D<class_Shape3D>` is a :ref:`HeightMapShape3D<class_HeightMapShape3D>`.
|
|
|
|
- **SHAPE_SOFT_BODY** = **9** --- The :ref:`Shape3D<class_Shape3D>` is used internally for a soft body. Any attempt to create this kind of shape results in an error.
|
|
|
|
- **SHAPE_CUSTOM** = **10** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_AreaParameter:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_OVERRIDE_MODE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_VECTOR:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_IS_POINT:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_ANGULAR_DAMP:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_PRIORITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_FORCE_MAGNITUDE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_SOURCE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_DIRECTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_PARAM_WIND_ATTENUATION_FACTOR:
|
|
|
|
enum **AreaParameter**:
|
|
|
|
- **AREA_PARAM_GRAVITY_OVERRIDE_MODE** = **0** --- Constant to set/get gravity override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
|
|
|
|
- **AREA_PARAM_GRAVITY** = **1** --- Constant to set/get gravity strength in an area.
|
|
|
|
- **AREA_PARAM_GRAVITY_VECTOR** = **2** --- Constant to set/get gravity vector/center in an area.
|
|
|
|
- **AREA_PARAM_GRAVITY_IS_POINT** = **3** --- Constant to set/get whether the gravity vector of an area is a direction, or a center point.
|
|
|
|
- **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = **4** --- Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
|
|
|
|
- **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = **5** --- This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE<class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE>`.
|
|
|
|
- **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = **6** --- Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
|
|
|
|
- **AREA_PARAM_LINEAR_DAMP** = **7** --- Constant to set/get the linear damping factor of an area.
|
|
|
|
- **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = **8** --- Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
|
|
|
|
- **AREA_PARAM_ANGULAR_DAMP** = **9** --- Constant to set/get the angular damping factor of an area.
|
|
|
|
- **AREA_PARAM_PRIORITY** = **10** --- Constant to set/get the priority (order of processing) of an area.
|
|
|
|
- **AREA_PARAM_WIND_FORCE_MAGNITUDE** = **11** --- Constant to set/get the magnitude of area-specific wind force.
|
|
|
|
- **AREA_PARAM_WIND_SOURCE** = **12** --- Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
|
|
|
|
- **AREA_PARAM_WIND_DIRECTION** = **13** --- Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
|
|
|
|
- **AREA_PARAM_WIND_ATTENUATION_FACTOR** = **14** --- Constant to set/get the exponential rate at which wind force decreases with distance from its origin.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_AreaSpaceOverrideMode:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_DISABLED:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE:
|
|
|
|
enum **AreaSpaceOverrideMode**:
|
|
|
|
- **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
|
|
|
|
- **AREA_SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
|
|
|
|
- **AREA_SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
|
|
|
|
- **AREA_SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
|
|
|
|
- **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_BodyMode:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_MODE_STATIC:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_MODE_KINEMATIC:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_MODE_DYNAMIC:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_MODE_DYNAMIC_LINEAR:
|
|
|
|
enum **BodyMode**:
|
|
|
|
- **BODY_MODE_STATIC** = **0** --- Constant for static bodies. In this mode, a body can be only moved by user code and doesn't collide with other bodies along its path when moved.
|
|
|
|
- **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. In this mode, a body can be only moved by user code and collides with other bodies along its path.
|
|
|
|
- **BODY_MODE_DYNAMIC** = **2** --- Constant for dynamic bodies. In this mode, a body can be pushed by other bodies and has forces applied.
|
|
|
|
- **BODY_MODE_DYNAMIC_LINEAR** = **3** --- Constant for linear dynamic bodies. In this mode, a body is dynamic but can not rotate, and only its linear velocity is affected by external forces.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_BodyParameter:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_BOUNCE:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_FRICTION:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_MASS:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_INERTIA:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_CENTER_OF_MASS:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_GRAVITY_SCALE:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP_MODE:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_PARAM_MAX:
|
|
|
|
enum **BodyParameter**:
|
|
|
|
- **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor.
|
|
|
|
- **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction.
|
|
|
|
- **BODY_PARAM_MASS** = **2** --- Constant to set/get a body's mass.
|
|
|
|
- **BODY_PARAM_INERTIA** = **3** --- Constant to set/get a body's inertia.
|
|
|
|
- **BODY_PARAM_CENTER_OF_MASS** = **4** --- Constant to set/get a body's center of mass position in the body's local coordinate system.
|
|
|
|
- **BODY_PARAM_GRAVITY_SCALE** = **5** --- Constant to set/get a body's gravity multiplier.
|
|
|
|
- **BODY_PARAM_LINEAR_DAMP_MODE** = **6** --- Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
|
|
|
|
- **BODY_PARAM_ANGULAR_DAMP_MODE** = **7** --- Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode<enum_PhysicsServer3D_BodyDampMode>` for possible values.
|
|
|
|
- **BODY_PARAM_LINEAR_DAMP** = **8** --- Constant to set/get a body's linear dampening factor.
|
|
|
|
- **BODY_PARAM_ANGULAR_DAMP** = **9** --- Constant to set/get a body's angular dampening factor.
|
|
|
|
- **BODY_PARAM_MAX** = **10** --- Represents the size of the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` enum.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_BodyDampMode:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_COMBINE:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_DAMP_MODE_REPLACE:
|
|
|
|
enum **BodyDampMode**:
|
|
|
|
- **BODY_DAMP_MODE_COMBINE** = **0** --- The body's damping value is added to any value set in areas or the default value.
|
|
|
|
- **BODY_DAMP_MODE_REPLACE** = **1** --- The body's damping value replaces any value set in areas or the default value.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_BodyState:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_STATE_TRANSFORM:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_STATE_LINEAR_VELOCITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_STATE_ANGULAR_VELOCITY:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_STATE_SLEEPING:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_STATE_CAN_SLEEP:
|
|
|
|
enum **BodyState**:
|
|
|
|
- **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body.
|
|
|
|
- **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body.
|
|
|
|
- **BODY_STATE_ANGULAR_VELOCITY** = **2** --- Constant to set/get the current angular velocity of the body.
|
|
|
|
- **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping.
|
|
|
|
- **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_AreaBodyStatus:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_BODY_ADDED:
|
|
|
|
.. _class_PhysicsServer3D_constant_AREA_BODY_REMOVED:
|
|
|
|
enum **AreaBodyStatus**:
|
|
|
|
- **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes.
|
|
|
|
- **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_ProcessInfo:
|
|
|
|
.. _class_PhysicsServer3D_constant_INFO_ACTIVE_OBJECTS:
|
|
|
|
.. _class_PhysicsServer3D_constant_INFO_COLLISION_PAIRS:
|
|
|
|
.. _class_PhysicsServer3D_constant_INFO_ISLAND_COUNT:
|
|
|
|
enum **ProcessInfo**:
|
|
|
|
- **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping.
|
|
|
|
- **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions.
|
|
|
|
- **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_SpaceParameter:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_CONTACT_DEFAULT_BIAS:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP:
|
|
|
|
.. _class_PhysicsServer3D_constant_SPACE_PARAM_SOLVER_ITERATIONS:
|
|
|
|
enum **SpaceParameter**:
|
|
|
|
- **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
|
|
|
|
- **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated and the contact is discarded.
|
|
|
|
- **SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
|
|
|
|
- **SPACE_PARAM_CONTACT_DEFAULT_BIAS** = **3** --- Constant to set/get the default solver bias for all physics contacts. A solver bias is a factor controlling how much two objects "rebound", after overlapping, to avoid leaving them in that state because of numerical imprecision.
|
|
|
|
- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **4** --- Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
|
|
|
|
- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **5** --- Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
|
|
|
|
- **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **6** --- Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
|
|
|
|
- **SPACE_PARAM_SOLVER_ITERATIONS** = **7** --- Constant to set/get the number of solver iterations for contacts and constraints. The greater the amount of iterations, the more accurate the collisions and constraints will be. However, a greater amount of iterations requires more CPU power, which can decrease performance.
|
|
|
|
----
|
|
|
|
.. _enum_PhysicsServer3D_BodyAxis:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_X:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Y:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_AXIS_LINEAR_Z:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_X:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Y:
|
|
|
|
.. _class_PhysicsServer3D_constant_BODY_AXIS_ANGULAR_Z:
|
|
|
|
enum **BodyAxis**:
|
|
|
|
- **BODY_AXIS_LINEAR_X** = **1**
|
|
|
|
- **BODY_AXIS_LINEAR_Y** = **2**
|
|
|
|
- **BODY_AXIS_LINEAR_Z** = **4**
|
|
|
|
- **BODY_AXIS_ANGULAR_X** = **8**
|
|
|
|
- **BODY_AXIS_ANGULAR_Y** = **16**
|
|
|
|
- **BODY_AXIS_ANGULAR_Z** = **32**
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_PhysicsServer3D_method_area_add_shape:
|
|
|
|
- void **area_add_shape** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)**
|
|
|
|
Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_attach_object_instance_id:
|
|
|
|
- void **area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)**
|
|
|
|
Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_clear_shapes:
|
|
|
|
- void **area_clear_shapes** **(** :ref:`RID<class_RID>` area **)**
|
|
|
|
Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_create:
|
|
|
|
- :ref:`RID<class_RID>` **area_create** **(** **)**
|
|
|
|
Creates an :ref:`Area3D<class_Area3D>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_object_instance_id:
|
|
|
|
- :ref:`int<class_int>` **area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** |const|
|
|
|
|
Gets the instance ID of the object the area is assigned to.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_param:
|
|
|
|
- :ref:`Variant<class_Variant>` **area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param **)** |const|
|
|
|
|
Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_shape:
|
|
|
|
- :ref:`RID<class_RID>` **area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
|
|
|
|
Returns the :ref:`RID<class_RID>` of the nth shape of an area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_shape_count:
|
|
|
|
- :ref:`int<class_int>` **area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** |const|
|
|
|
|
Returns the number of shapes assigned to an area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_shape_transform:
|
|
|
|
- :ref:`Transform3D<class_Transform3D>` **area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |const|
|
|
|
|
Returns the transform matrix of a shape within an area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_space:
|
|
|
|
- :ref:`RID<class_RID>` **area_get_space** **(** :ref:`RID<class_RID>` area **)** |const|
|
|
|
|
Returns the space assigned to the area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_get_transform:
|
|
|
|
- :ref:`Transform3D<class_Transform3D>` **area_get_transform** **(** :ref:`RID<class_RID>` area **)** |const|
|
|
|
|
Returns the transform matrix for an area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_remove_shape:
|
|
|
|
- void **area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)**
|
|
|
|
Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_area_monitor_callback:
|
|
|
|
- void **area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_collision_layer:
|
|
|
|
- void **area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)**
|
|
|
|
Assigns the area to one or many physics layers.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_collision_mask:
|
|
|
|
- void **area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)**
|
|
|
|
Sets which physics layers the area will monitor.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_monitor_callback:
|
|
|
|
- void **area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)**
|
|
|
|
Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
|
|
|
|
1: :ref:`AREA_BODY_ADDED<class_PhysicsServer3D_constant_AREA_BODY_ADDED>` or :ref:`AREA_BODY_REMOVED<class_PhysicsServer3D_constant_AREA_BODY_REMOVED>`, depending on whether the object entered or exited the area.
|
|
|
|
2: :ref:`RID<class_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.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_monitorable:
|
|
|
|
- void **area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_param:
|
|
|
|
- void **area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)**
|
|
|
|
Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` constants.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_ray_pickable:
|
|
|
|
- void **area_set_ray_pickable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` enable **)**
|
|
|
|
Sets object pickable with rays.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_shape:
|
|
|
|
- void **area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
|
|
|
|
Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_shape_disabled:
|
|
|
|
- void **area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_shape_transform:
|
|
|
|
- void **area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)**
|
|
|
|
Sets the transform matrix for an area shape.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_space:
|
|
|
|
- void **area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)**
|
|
|
|
Assigns a space to the area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_area_set_transform:
|
|
|
|
- void **area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform3D<class_Transform3D>` transform **)**
|
|
|
|
Sets the transform matrix for an area.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_add_collision_exception:
|
|
|
|
- void **body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
|
|
|
|
Adds a body to the list of bodies exempt from collisions.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_add_constant_central_force:
|
|
|
|
- void **body_add_constant_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)**
|
|
|
|
Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``.
|
|
|
|
This is equivalent to using :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` at the body's center of mass.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_add_constant_force:
|
|
|
|
- void **body_add_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
|
|
|
|
Adds a constant positioned force to the body that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``.
|
|
|
|
\ ``position`` is the offset from the body origin in global coordinates.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_add_constant_torque:
|
|
|
|
- void **body_add_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)**
|
|
|
|
Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``body_set_constant_torque(body, Vector3(0, 0, 0))``.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_add_shape:
|
|
|
|
- void **body_add_shape** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform3D<class_Transform3D>` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool<class_bool>` disabled=false **)**
|
|
|
|
Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_apply_central_force:
|
|
|
|
- void **body_apply_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)**
|
|
|
|
Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
|
|
|
|
This is equivalent to using :ref:`body_apply_force<class_PhysicsServer3D_method_body_apply_force>` at the body's center of mass.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_apply_central_impulse:
|
|
|
|
- void **body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)**
|
|
|
|
Applies a directional impulse without affecting rotation.
|
|
|
|
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
|
|
|
|
This is equivalent to using :ref:`body_apply_impulse<class_PhysicsServer3D_method_body_apply_impulse>` at the body's center of mass.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_apply_force:
|
|
|
|
- void **body_apply_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
|
|
|
|
Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
|
|
|
|
\ ``position`` is the offset from the body origin in global coordinates.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_apply_impulse:
|
|
|
|
- void **body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse, :ref:`Vector3<class_Vector3>` position=Vector3(0, 0, 0) **)**
|
|
|
|
Applies a positioned impulse to the body.
|
|
|
|
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
|
|
|
|
\ ``position`` is the offset from the body origin in global coordinates.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_apply_torque:
|
|
|
|
- void **body_apply_torque** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)**
|
|
|
|
Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_apply_torque_impulse:
|
|
|
|
- void **body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` impulse **)**
|
|
|
|
Applies a rotational impulse to the body without affecting the position.
|
|
|
|
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_attach_object_instance_id:
|
|
|
|
- void **body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)**
|
|
|
|
Assigns the area to a descendant of :ref:`Object<class_Object>`, so it can exist in the node tree.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_clear_shapes:
|
|
|
|
- void **body_clear_shapes** **(** :ref:`RID<class_RID>` body **)**
|
|
|
|
Removes all shapes from a body.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_create:
|
|
|
|
- :ref:`RID<class_RID>` **body_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_collision_layer:
|
|
|
|
- :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the physics layer or layers a body belongs to.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_collision_mask:
|
|
|
|
- :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the physics layer or layers a body can collide with.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_constant_force:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **body_get_constant_force** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the body's total constant positional forces applied during each physics update.
|
|
|
|
See :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_constant_torque:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **body_get_constant_torque** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the body's total constant rotational forces applied during each physics update.
|
|
|
|
See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_direct_state:
|
|
|
|
- :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` **body_get_direct_state** **(** :ref:`RID<class_RID>` body **)**
|
|
|
|
Returns the :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` of the body. Returns ``null`` if the body is destroyed or removed from the physics space.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_max_contacts_reported:
|
|
|
|
- :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported<class_PhysicsServer3D_method_body_set_max_contacts_reported>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_mode:
|
|
|
|
- :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` **body_get_mode** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the body mode.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_object_instance_id:
|
|
|
|
- :ref:`int<class_int>` **body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Gets the instance ID of the object the area is assigned to.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_param:
|
|
|
|
- :ref:`Variant<class_Variant>` **body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param **)** |const|
|
|
|
|
Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_shape:
|
|
|
|
- :ref:`RID<class_RID>` **body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
|
|
|
|
Returns the :ref:`RID<class_RID>` of the nth shape of a body.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_shape_count:
|
|
|
|
- :ref:`int<class_int>` **body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the number of shapes assigned to a body.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_shape_transform:
|
|
|
|
- :ref:`Transform3D<class_Transform3D>` **body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |const|
|
|
|
|
Returns the transform matrix of a body shape.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_space:
|
|
|
|
- :ref:`RID<class_RID>` **body_get_space** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns the :ref:`RID<class_RID>` of the space assigned to a body.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_get_state:
|
|
|
|
- :ref:`Variant<class_Variant>` **body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state **)** |const|
|
|
|
|
Returns a body state.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_is_axis_locked:
|
|
|
|
- :ref:`bool<class_bool>` **body_is_axis_locked** **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
If ``true``, the continuous collision detection mode is enabled.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_is_omitting_force_integration:
|
|
|
|
- :ref:`bool<class_bool>` **body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>`).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_remove_collision_exception:
|
|
|
|
- void **body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)**
|
|
|
|
Removes a body from the list of bodies exempt from collisions.
|
|
|
|
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_remove_shape:
|
|
|
|
- void **body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)**
|
|
|
|
Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_reset_mass_properties:
|
|
|
|
- void **body_reset_mass_properties** **(** :ref:`RID<class_RID>` body **)**
|
|
|
|
Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using :ref:`body_set_param<class_PhysicsServer3D_method_body_set_param>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_axis_lock:
|
|
|
|
- void **body_set_axis_lock** **(** :ref:`RID<class_RID>` body, :ref:`BodyAxis<enum_PhysicsServer3D_BodyAxis>` axis, :ref:`bool<class_bool>` lock **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_axis_velocity:
|
|
|
|
- void **body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` axis_velocity **)**
|
|
|
|
Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_collision_layer:
|
|
|
|
- void **body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)**
|
|
|
|
Sets the physics layer or layers a body belongs to.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_collision_mask:
|
|
|
|
- void **body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)**
|
|
|
|
Sets the physics layer or layers a body can collide with.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_constant_force:
|
|
|
|
- void **body_set_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` force **)**
|
|
|
|
Sets the body's total constant positional forces applied during each physics update.
|
|
|
|
See :ref:`body_add_constant_force<class_PhysicsServer3D_method_body_add_constant_force>` and :ref:`body_add_constant_central_force<class_PhysicsServer3D_method_body_add_constant_central_force>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_constant_torque:
|
|
|
|
- void **body_set_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`Vector3<class_Vector3>` torque **)**
|
|
|
|
Sets the body's total constant rotational forces applied during each physics update.
|
|
|
|
See :ref:`body_add_constant_torque<class_PhysicsServer3D_method_body_add_constant_torque>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_enable_continuous_collision_detection:
|
|
|
|
- void **body_set_enable_continuous_collision_detection** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
|
|
|
|
If ``true``, the continuous collision detection mode is enabled.
|
|
|
|
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_force_integration_callback:
|
|
|
|
- void **body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata=null **)**
|
|
|
|
Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration<class_PhysicsServer3D_method_body_set_omit_force_integration>`).
|
|
|
|
The force integration function takes 2 arguments:
|
|
|
|
\ ``state:`` :ref:`PhysicsDirectBodyState3D<class_PhysicsDirectBodyState3D>` used to retrieve and modify the body's state.
|
|
|
|
\ ``userdata:`` Optional user data, if it was passed when calling ``body_set_force_integration_callback``.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_max_contacts_reported:
|
|
|
|
- void **body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)**
|
|
|
|
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_mode:
|
|
|
|
- void **body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` mode **)**
|
|
|
|
Sets the body mode, from one of the :ref:`BodyMode<enum_PhysicsServer3D_BodyMode>` constants.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_omit_force_integration:
|
|
|
|
- void **body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
|
|
|
|
Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback<class_PhysicsServer3D_method_body_set_force_integration_callback>`).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_param:
|
|
|
|
- void **body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)**
|
|
|
|
Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter<enum_PhysicsServer3D_BodyParameter>` constants.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_ray_pickable:
|
|
|
|
- void **body_set_ray_pickable** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)**
|
|
|
|
Sets the body pickable with rays if ``enabled`` is set.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_shape:
|
|
|
|
- void **body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)**
|
|
|
|
Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID<class_RID>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_shape_disabled:
|
|
|
|
- void **body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_shape_transform:
|
|
|
|
- void **body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform3D<class_Transform3D>` transform **)**
|
|
|
|
Sets the transform matrix for a body shape.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_space:
|
|
|
|
- void **body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)**
|
|
|
|
Assigns a space to the body (see :ref:`space_create<class_PhysicsServer3D_method_space_create>`).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_set_state:
|
|
|
|
- void **body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer3D_BodyState>` state, :ref:`Variant<class_Variant>` value **)**
|
|
|
|
Sets a body state (see :ref:`BodyState<enum_PhysicsServer3D_BodyState>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_body_test_motion:
|
|
|
|
- :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>` parameters, :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` result=null **)**
|
|
|
|
Returns ``true`` if a collision would result from moving along a motion vector from a given point in space. :ref:`PhysicsTestMotionParameters3D<class_PhysicsTestMotionParameters3D>` is passed to set motion parameters. :ref:`PhysicsTestMotionResult3D<class_PhysicsTestMotionResult3D>` can be passed to return additional information.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_box_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **box_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_capsule_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **capsule_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_concave_polygon_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **concave_polygon_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_cone_twist_joint_get_param:
|
|
|
|
- :ref:`float<class_float>` **cone_twist_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param **)** |const|
|
|
|
|
Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_cone_twist_joint_set_param:
|
|
|
|
- void **cone_twist_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam<enum_PhysicsServer3D_ConeTwistJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_convex_polygon_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **convex_polygon_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_custom_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **custom_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_cylinder_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **cylinder_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_free_rid:
|
|
|
|
- void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
|
|
|
|
Destroys any of the objects created by PhysicsServer3D. If the :ref:`RID<class_RID>` passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_generic_6dof_joint_get_flag:
|
|
|
|
- :ref:`bool<class_bool>` **generic_6dof_joint_get_flag** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag **)** |const|
|
|
|
|
Gets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_generic_6dof_joint_get_param:
|
|
|
|
- :ref:`float<class_float>` **generic_6dof_joint_get_param** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param **)** |const|
|
|
|
|
Gets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_generic_6dof_joint_set_flag:
|
|
|
|
- void **generic_6dof_joint_set_flag** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` flag, :ref:`bool<class_bool>` enable **)**
|
|
|
|
Sets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag<enum_PhysicsServer3D_G6DOFJointAxisFlag>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_generic_6dof_joint_set_param:
|
|
|
|
- void **generic_6dof_joint_set_param** **(** :ref:`RID<class_RID>` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Sets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam<enum_PhysicsServer3D_G6DOFJointAxisParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_get_process_info:
|
|
|
|
- :ref:`int<class_int>` **get_process_info** **(** :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` process_info **)**
|
|
|
|
Returns information about the current state of the 3D physics engine. See :ref:`ProcessInfo<enum_PhysicsServer3D_ProcessInfo>` for a list of available states.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_heightmap_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **heightmap_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_hinge_joint_get_flag:
|
|
|
|
- :ref:`bool<class_bool>` **hinge_joint_get_flag** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag **)** |const|
|
|
|
|
Gets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_hinge_joint_get_param:
|
|
|
|
- :ref:`float<class_float>` **hinge_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param **)** |const|
|
|
|
|
Gets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>`).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_hinge_joint_set_flag:
|
|
|
|
- void **hinge_joint_set_flag** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` flag, :ref:`bool<class_bool>` enabled **)**
|
|
|
|
Sets a hinge_joint flag (see :ref:`HingeJointFlag<enum_PhysicsServer3D_HingeJointFlag>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_hinge_joint_set_param:
|
|
|
|
- void **hinge_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Sets a hinge_joint parameter (see :ref:`HingeJointParam<enum_PhysicsServer3D_HingeJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_clear:
|
|
|
|
- void **joint_clear** **(** :ref:`RID<class_RID>` joint **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_create:
|
|
|
|
- :ref:`RID<class_RID>` **joint_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_get_solver_priority:
|
|
|
|
- :ref:`int<class_int>` **joint_get_solver_priority** **(** :ref:`RID<class_RID>` joint **)** |const|
|
|
|
|
Gets the priority value of the Joint3D.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_get_type:
|
|
|
|
- :ref:`JointType<enum_PhysicsServer3D_JointType>` **joint_get_type** **(** :ref:`RID<class_RID>` joint **)** |const|
|
|
|
|
Returns the type of the Joint3D.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_make_cone_twist:
|
|
|
|
- void **joint_make_cone_twist** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_make_generic_6dof:
|
|
|
|
- void **joint_make_generic_6dof** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_make_hinge:
|
|
|
|
- void **joint_make_hinge** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` hinge_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` hinge_B **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_make_pin:
|
|
|
|
- void **joint_make_pin** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Vector3<class_Vector3>` local_A, :ref:`RID<class_RID>` body_B, :ref:`Vector3<class_Vector3>` local_B **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_make_slider:
|
|
|
|
- void **joint_make_slider** **(** :ref:`RID<class_RID>` joint, :ref:`RID<class_RID>` body_A, :ref:`Transform3D<class_Transform3D>` local_ref_A, :ref:`RID<class_RID>` body_B, :ref:`Transform3D<class_Transform3D>` local_ref_B **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_joint_set_solver_priority:
|
|
|
|
- void **joint_set_solver_priority** **(** :ref:`RID<class_RID>` joint, :ref:`int<class_int>` priority **)**
|
|
|
|
Sets the priority value of the Joint3D.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_pin_joint_get_local_a:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **pin_joint_get_local_a** **(** :ref:`RID<class_RID>` joint **)** |const|
|
|
|
|
Returns position of the joint in the local space of body a of the joint.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_pin_joint_get_local_b:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **pin_joint_get_local_b** **(** :ref:`RID<class_RID>` joint **)** |const|
|
|
|
|
Returns position of the joint in the local space of body b of the joint.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_pin_joint_get_param:
|
|
|
|
- :ref:`float<class_float>` **pin_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param **)** |const|
|
|
|
|
Gets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_pin_joint_set_local_a:
|
|
|
|
- void **pin_joint_set_local_a** **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_A **)**
|
|
|
|
Sets position of the joint in the local space of body a of the joint.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_pin_joint_set_local_b:
|
|
|
|
- void **pin_joint_set_local_b** **(** :ref:`RID<class_RID>` joint, :ref:`Vector3<class_Vector3>` local_B **)**
|
|
|
|
Sets position of the joint in the local space of body b of the joint.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_pin_joint_set_param:
|
|
|
|
- void **pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Sets a pin_joint parameter (see :ref:`PinJointParam<enum_PhysicsServer3D_PinJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_separation_ray_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **separation_ray_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_set_active:
|
|
|
|
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
|
|
|
|
Activates or deactivates the 3D physics engine.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_shape_get_data:
|
|
|
|
- :ref:`Variant<class_Variant>` **shape_get_data** **(** :ref:`RID<class_RID>` shape **)** |const|
|
|
|
|
Returns the shape data.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_shape_get_type:
|
|
|
|
- :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` **shape_get_type** **(** :ref:`RID<class_RID>` shape **)** |const|
|
|
|
|
Returns the type of shape (see :ref:`ShapeType<enum_PhysicsServer3D_ShapeType>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_shape_set_data:
|
|
|
|
- void **shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)**
|
|
|
|
Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type<class_PhysicsServer3D_method_shape_get_type>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_slider_joint_get_param:
|
|
|
|
- :ref:`float<class_float>` **slider_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param **)** |const|
|
|
|
|
Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_slider_joint_set_param:
|
|
|
|
- void **slider_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Gets a slider_joint parameter (see :ref:`SliderJointParam<enum_PhysicsServer3D_SliderJointParam>` constants).
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_soft_body_get_bounds:
|
|
|
|
- :ref:`AABB<class_AABB>` **soft_body_get_bounds** **(** :ref:`RID<class_RID>` body **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_space_create:
|
|
|
|
- :ref:`RID<class_RID>` **space_create** **(** **)**
|
|
|
|
Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space<class_PhysicsServer3D_method_area_set_space>`, or to a body with :ref:`body_set_space<class_PhysicsServer3D_method_body_set_space>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_space_get_direct_state:
|
|
|
|
- :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **space_get_direct_state** **(** :ref:`RID<class_RID>` space **)**
|
|
|
|
Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>`. This object can be used to make collision/intersection queries.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_space_get_param:
|
|
|
|
- :ref:`float<class_float>` **space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param **)** |const|
|
|
|
|
Returns the value of a space parameter.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_space_is_active:
|
|
|
|
- :ref:`bool<class_bool>` **space_is_active** **(** :ref:`RID<class_RID>` space **)** |const|
|
|
|
|
Returns whether the space is active.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_space_set_active:
|
|
|
|
- void **space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)**
|
|
|
|
Marks a space as active. It will not have an effect, unless it is assigned to an area or body.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_space_set_param:
|
|
|
|
- void **space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter<enum_PhysicsServer3D_SpaceParameter>` constants.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_sphere_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **sphere_shape_create** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_PhysicsServer3D_method_world_boundary_shape_create:
|
|
|
|
- :ref:`RID<class_RID>` **world_boundary_shape_create** **(** **)**
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|