: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/HingeJoint3D.xml. .. _class_HingeJoint3D: HingeJoint3D ============ **Inherits:** :ref:`Joint3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body. .. rst-class:: classref-introduction-group Description ----------- A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body. For example, Body A can be a :ref:`StaticBody3D` representing a door hinge that a :ref:`RigidBody3D` rotates around. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`angular_limit/bias` | ``0.3`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`bool` | :ref:`angular_limit/enable` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`angular_limit/lower` | ``-1.5707964`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`angular_limit/relaxation` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`angular_limit/softness` | ``0.9`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`angular_limit/upper` | ``1.5707964`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`bool` | :ref:`motor/enable` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`motor/max_impulse` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`motor/target_velocity` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`params/bias` | ``0.3`` | +---------------------------+---------------------------------------------------------------------------------------+----------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag`\ (\ flag\: :ref:`Flag`\ ) |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_flag`\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_HingeJoint3D_Param: .. rst-class:: classref-enumeration enum **Param**: :ref:`🔗` .. _class_HingeJoint3D_constant_PARAM_BIAS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_BIAS** = ``0`` The speed with which the two bodies get pulled together when they move in different directions. .. _class_HingeJoint3D_constant_PARAM_LIMIT_UPPER: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LIMIT_UPPER** = ``1`` The maximum rotation. Only active if :ref:`angular_limit/enable` is ``true``. .. _class_HingeJoint3D_constant_PARAM_LIMIT_LOWER: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LIMIT_LOWER** = ``2`` The minimum rotation. Only active if :ref:`angular_limit/enable` is ``true``. .. _class_HingeJoint3D_constant_PARAM_LIMIT_BIAS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LIMIT_BIAS** = ``3`` The speed with which the rotation across the axis perpendicular to the hinge gets corrected. .. _class_HingeJoint3D_constant_PARAM_LIMIT_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LIMIT_SOFTNESS** = ``4`` **Deprecated:** This property is never used by the engine and is kept for compatibility purpose. .. _class_HingeJoint3D_constant_PARAM_LIMIT_RELAXATION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LIMIT_RELAXATION** = ``5`` The lower this value, the more the rotation gets slowed down. .. _class_HingeJoint3D_constant_PARAM_MOTOR_TARGET_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_MOTOR_TARGET_VELOCITY** = ``6`` Target speed for the motor. .. _class_HingeJoint3D_constant_PARAM_MOTOR_MAX_IMPULSE: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_MOTOR_MAX_IMPULSE** = ``7`` Maximum acceleration for the motor. .. _class_HingeJoint3D_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_MAX** = ``8`` Represents the size of the :ref:`Param` enum. .. rst-class:: classref-item-separator ---- .. _enum_HingeJoint3D_Flag: .. rst-class:: classref-enumeration enum **Flag**: :ref:`🔗` .. _class_HingeJoint3D_constant_FLAG_USE_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_USE_LIMIT** = ``0`` If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. .. _class_HingeJoint3D_constant_FLAG_ENABLE_MOTOR: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_MOTOR** = ``1`` When activated, a motor turns the hinge. .. _class_HingeJoint3D_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_MAX** = ``2`` Represents the size of the :ref:`Flag` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_HingeJoint3D_property_angular_limit/bias: .. rst-class:: classref-property :ref:`float` **angular_limit/bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The speed with which the rotation across the axis perpendicular to the hinge gets corrected. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_angular_limit/enable: .. rst-class:: classref-property :ref:`bool` **angular_limit/enable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_angular_limit/lower: .. rst-class:: classref-property :ref:`float` **angular_limit/lower** = ``-1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation. Only active if :ref:`angular_limit/enable` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_angular_limit/relaxation: .. rst-class:: classref-property :ref:`float` **angular_limit/relaxation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The lower this value, the more the rotation gets slowed down. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_angular_limit/softness: .. rst-class:: classref-property :ref:`float` **angular_limit/softness** = ``0.9`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| **Deprecated:** This property is never set by the engine and is kept for compatibility purposes. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_angular_limit/upper: .. rst-class:: classref-property :ref:`float` **angular_limit/upper** = ``1.5707964`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The maximum rotation. Only active if :ref:`angular_limit/enable` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_motor/enable: .. rst-class:: classref-property :ref:`bool` **motor/enable** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| When activated, a motor turns the hinge. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_motor/max_impulse: .. rst-class:: classref-property :ref:`float` **motor/max_impulse** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Maximum acceleration for the motor. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_motor/target_velocity: .. rst-class:: classref-property :ref:`float` **motor/target_velocity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Target speed for the motor. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_property_params/bias: .. rst-class:: classref-property :ref:`float` **params/bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The speed with which the two bodies get pulled together when they move in different directions. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_HingeJoint3D_method_get_flag: .. rst-class:: classref-method :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| :ref:`🔗` Returns the value of the specified flag. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_method_get_param: .. rst-class:: classref-method :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the specified parameter. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_method_set_flag: .. rst-class:: classref-method |void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) :ref:`🔗` If ``true``, enables the specified flag. .. rst-class:: classref-item-separator ---- .. _class_HingeJoint3D_method_set_param: .. rst-class:: classref-method |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the specified parameter. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`