class_visualscriptmathconstant.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScriptMathConstant.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScriptMathConstant:
  5. VisualScriptMathConstant
  6. ========================
  7. **Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Commonly used mathematical constants.
  12. Member Variables
  13. ----------------
  14. .. _class_VisualScriptMathConstant_constant:
  15. - :ref:`int<class_int>` **constant** - The math constant.
  16. Numeric Constants
  17. -----------------
  18. - **MATH_CONSTANT_ONE** = **0** --- Unity: ``1``
  19. - **MATH_CONSTANT_PI** = **1** --- Pi: ``3.141593``
  20. - **MATH_CONSTANT_HALF_PI** = **2** --- Pi divided by two: ``1.570796``
  21. - **MATH_CONSTANT_TAU** = **3** --- Tau: ``6.283185``
  22. - **MATH_CONSTANT_E** = **4** --- Natural log: ``2.718282``
  23. - **MATH_CONSTANT_SQRT2** = **5** --- Square root of two: ``1.414214``
  24. - **MATH_CONSTANT_INF** = **6** --- Infinity: ``inf``
  25. - **MATH_CONSTANT_NAN** = **7** --- Not a number: ``nan``
  26. - **MATH_CONSTANT_MAX** = **8**
  27. Description
  28. -----------
  29. Provides common math constants, such as Pi or Euler's constant, on an output Data port.
  30. **Input Ports:**
  31. none
  32. **Output Ports:**
  33. - Data (variant): ``get``