156 lines
4.7 KiB
ReStructuredText
156 lines
4.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptMathConstant.xml.
|
|
|
|
.. _class_VisualScriptMathConstant:
|
|
|
|
VisualScriptMathConstant
|
|
========================
|
|
|
|
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Commonly used mathematical constants.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Provides common math constants, such as Pi, on an output Data port.
|
|
|
|
\ **Input Ports:**\
|
|
|
|
none
|
|
|
|
\ **Output Ports:**\
|
|
|
|
- Data (variant): ``get``
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------------------------------------+-------------------------------------------------------------------+-------+
|
|
| :ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` | :ref:`constant<class_VisualScriptMathConstant_property_constant>` | ``0`` |
|
|
+-----------------------------------------------------------------+-------------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualScriptMathConstant_MathConstant:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **MathConstant**:
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_ONE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_ONE** = ``0``
|
|
|
|
Unity: ``1``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_PI:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_PI** = ``1``
|
|
|
|
Pi: ``3.141593``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_HALF_PI:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_HALF_PI** = ``2``
|
|
|
|
Pi divided by two: ``1.570796``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_TAU:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_TAU** = ``3``
|
|
|
|
Tau: ``6.283185``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_E:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_E** = ``4``
|
|
|
|
Mathematical constant ``e``, the natural log base: ``2.718282``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_SQRT2:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_SQRT2** = ``5``
|
|
|
|
Square root of two: ``1.414214``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_INF:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_INF** = ``6``
|
|
|
|
Infinity: ``inf``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_NAN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_NAN** = ``7``
|
|
|
|
Not a number: ``nan``.
|
|
|
|
.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **MATH_CONSTANT_MAX** = ``8``
|
|
|
|
Represents the size of the :ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualScriptMathConstant_property_constant:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **constant** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_math_constant** **(** :ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` value **)**
|
|
- :ref:`MathConstant<enum_VisualScriptMathConstant_MathConstant>` **get_math_constant** **(** **)**
|
|
|
|
The math constant.
|
|
|
|
.. |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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|