: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/SliderJoint3D.xml. .. _class_SliderJoint3D: SliderJoint3D ============= **Inherits:** :ref:`Joint3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body. .. rst-class:: classref-introduction-group Description ----------- A physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body. For example, Body A could be a :ref:`StaticBody3D` representing a piston base, while Body B could be a :ref:`RigidBody3D` representing the piston head, moving up and down. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_limit/damping` | ``0.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_limit/lower_angle` | ``0.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_limit/restitution` | ``0.7`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_limit/softness` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_limit/upper_angle` | ``0.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_motion/damping` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_motion/restitution` | ``0.7`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_motion/softness` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_ortho/damping` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_ortho/restitution` | ``0.7`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`angular_ortho/softness` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_limit/damping` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_limit/lower_distance` | ``-1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_limit/restitution` | ``0.7`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_limit/softness` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_limit/upper_distance` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_motion/damping` | ``0.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_motion/restitution` | ``0.7`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_motion/softness` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_ortho/damping` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_ortho/restitution` | ``0.7`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`linear_ortho/softness` | ``1.0`` | +---------------------------+----------------------------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SliderJoint3D_Param: .. rst-class:: classref-enumeration enum **Param**: :ref:`🔗` .. _class_SliderJoint3D_constant_PARAM_LINEAR_LIMIT_UPPER: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LIMIT_UPPER** = ``0`` Constant for accessing :ref:`linear_limit/upper_distance`. The maximum difference between the pivot points on their X axis before damping happens. .. _class_SliderJoint3D_constant_PARAM_LINEAR_LIMIT_LOWER: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LIMIT_LOWER** = ``1`` Constant for accessing :ref:`linear_limit/lower_distance`. The minimum difference between the pivot points on their X axis before damping happens. .. _class_SliderJoint3D_constant_PARAM_LINEAR_LIMIT_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LIMIT_SOFTNESS** = ``2`` Constant for accessing :ref:`linear_limit/softness`. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. .. _class_SliderJoint3D_constant_PARAM_LINEAR_LIMIT_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LIMIT_RESTITUTION** = ``3`` Constant for accessing :ref:`linear_limit/restitution`. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. .. _class_SliderJoint3D_constant_PARAM_LINEAR_LIMIT_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LIMIT_DAMPING** = ``4`` Constant for accessing :ref:`linear_limit/damping`. The amount of damping once the slider limits are surpassed. .. _class_SliderJoint3D_constant_PARAM_LINEAR_MOTION_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_MOTION_SOFTNESS** = ``5`` Constant for accessing :ref:`linear_motion/softness`. 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. .. _class_SliderJoint3D_constant_PARAM_LINEAR_MOTION_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_MOTION_RESTITUTION** = ``6`` Constant for accessing :ref:`linear_motion/restitution`. The amount of restitution inside the slider limits. .. _class_SliderJoint3D_constant_PARAM_LINEAR_MOTION_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_MOTION_DAMPING** = ``7`` Constant for accessing :ref:`linear_motion/damping`. The amount of damping inside the slider limits. .. _class_SliderJoint3D_constant_PARAM_LINEAR_ORTHOGONAL_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_ORTHOGONAL_SOFTNESS** = ``8`` Constant for accessing :ref:`linear_ortho/softness`. A factor applied to the movement across axes orthogonal to the slider. .. _class_SliderJoint3D_constant_PARAM_LINEAR_ORTHOGONAL_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_ORTHOGONAL_RESTITUTION** = ``9`` Constant for accessing :ref:`linear_motion/restitution`. The amount of restitution when movement is across axes orthogonal to the slider. .. _class_SliderJoint3D_constant_PARAM_LINEAR_ORTHOGONAL_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_ORTHOGONAL_DAMPING** = ``10`` Constant for accessing :ref:`linear_motion/damping`. The amount of damping when movement is across axes orthogonal to the slider. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_LIMIT_UPPER: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LIMIT_UPPER** = ``11`` Constant for accessing :ref:`angular_limit/upper_angle`. The upper limit of rotation in the slider. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_LIMIT_LOWER: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LIMIT_LOWER** = ``12`` Constant for accessing :ref:`angular_limit/lower_angle`. The lower limit of rotation in the slider. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_LIMIT_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LIMIT_SOFTNESS** = ``13`` Constant for accessing :ref:`angular_limit/softness`. A factor applied to the all rotation once the limit is surpassed. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_LIMIT_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LIMIT_RESTITUTION** = ``14`` Constant for accessing :ref:`angular_limit/restitution`. The amount of restitution of the rotation when the limit is surpassed. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_LIMIT_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LIMIT_DAMPING** = ``15`` Constant for accessing :ref:`angular_limit/damping`. The amount of damping of the rotation when the limit is surpassed. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_MOTION_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_MOTION_SOFTNESS** = ``16`` Constant for accessing :ref:`angular_motion/softness`. A factor applied to the all rotation in the limits. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_MOTION_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_MOTION_RESTITUTION** = ``17`` Constant for accessing :ref:`angular_motion/restitution`. The amount of restitution of the rotation in the limits. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_MOTION_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_MOTION_DAMPING** = ``18`` Constant for accessing :ref:`angular_motion/damping`. The amount of damping of the rotation in the limits. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_ORTHOGONAL_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_ORTHOGONAL_SOFTNESS** = ``19`` Constant for accessing :ref:`angular_ortho/softness`. A factor applied to the all rotation across axes orthogonal to the slider. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_ORTHOGONAL_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_ORTHOGONAL_RESTITUTION** = ``20`` Constant for accessing :ref:`angular_ortho/restitution`. The amount of restitution of the rotation across axes orthogonal to the slider. .. _class_SliderJoint3D_constant_PARAM_ANGULAR_ORTHOGONAL_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_ORTHOGONAL_DAMPING** = ``21`` Constant for accessing :ref:`angular_ortho/damping`. The amount of damping of the rotation across axes orthogonal to the slider. .. _class_SliderJoint3D_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_MAX** = ``22`` Represents the size of the :ref:`Param` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SliderJoint3D_property_angular_limit/damping: .. rst-class:: classref-property :ref:`float` **angular_limit/damping** = ``0.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 amount of damping of the rotation when the limit is surpassed. A lower damping value allows a rotation initiated by body A to travel to body B slower. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_limit/lower_angle: .. rst-class:: classref-property :ref:`float` **angular_limit/lower_angle** = ``0.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 limit of rotation in the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_limit/restitution: .. rst-class:: classref-property :ref:`float` **angular_limit/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_limit/softness: .. rst-class:: classref-property :ref:`float` **angular_limit/softness** = ``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| A factor applied to the all rotation once the limit is surpassed. Makes all rotation slower when between 0 and 1. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_limit/upper_angle: .. rst-class:: classref-property :ref:`float` **angular_limit/upper_angle** = ``0.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 upper limit of rotation in the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_motion/damping: .. rst-class:: classref-property :ref:`float` **angular_motion/damping** = ``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 amount of damping of the rotation in the limits. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_motion/restitution: .. rst-class:: classref-property :ref:`float` **angular_motion/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution of the rotation in the limits. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_motion/softness: .. rst-class:: classref-property :ref:`float` **angular_motion/softness** = ``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| A factor applied to the all rotation in the limits. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_ortho/damping: .. rst-class:: classref-property :ref:`float` **angular_ortho/damping** = ``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 amount of damping of the rotation across axes orthogonal to the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_ortho/restitution: .. rst-class:: classref-property :ref:`float` **angular_ortho/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution of the rotation across axes orthogonal to the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_angular_ortho/softness: .. rst-class:: classref-property :ref:`float` **angular_ortho/softness** = ``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| A factor applied to the all rotation across axes orthogonal to the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_limit/damping: .. rst-class:: classref-property :ref:`float` **linear_limit/damping** = ``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 amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_limit/lower_distance: .. rst-class:: classref-property :ref:`float` **linear_limit/lower_distance** = ``-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 minimum difference between the pivot points on their X axis before damping happens. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_limit/restitution: .. rst-class:: classref-property :ref:`float` **linear_limit/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_limit/softness: .. rst-class:: classref-property :ref:`float` **linear_limit/softness** = ``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| A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_limit/upper_distance: .. rst-class:: classref-property :ref:`float` **linear_limit/upper_distance** = ``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 maximum difference between the pivot points on their X axis before damping happens. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_motion/damping: .. rst-class:: classref-property :ref:`float` **linear_motion/damping** = ``0.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 amount of damping inside the slider limits. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_motion/restitution: .. rst-class:: classref-property :ref:`float` **linear_motion/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution inside the slider limits. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_motion/softness: .. rst-class:: classref-property :ref:`float` **linear_motion/softness** = ``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| 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. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_ortho/damping: .. rst-class:: classref-property :ref:`float` **linear_ortho/damping** = ``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 amount of damping when movement is across axes orthogonal to the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_ortho/restitution: .. rst-class:: classref-property :ref:`float` **linear_ortho/restitution** = ``0.7`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution when movement is across axes orthogonal to the slider. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_property_linear_ortho/softness: .. rst-class:: classref-property :ref:`float` **linear_ortho/softness** = ``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| A factor applied to the movement across axes orthogonal to the slider. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SliderJoint3D_method_get_param: .. rst-class:: classref-method :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the given parameter. .. rst-class:: classref-item-separator ---- .. _class_SliderJoint3D_method_set_param: .. rst-class:: classref-method |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Assigns ``value`` to the given 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.)`