class_float.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the float.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_float:
  6. float
  7. =====
  8. **Category:** Built-In Types
  9. Brief Description
  10. -----------------
  11. Float built-in type
  12. Methods
  13. -------
  14. +---------------------------+-------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`float<class_float_method_float>` **(** :ref:`bool<class_bool>` from **)** |
  16. +---------------------------+-------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`float<class_float_method_float>` **(** :ref:`int<class_int>` from **)** |
  18. +---------------------------+-------------------------------------------------------------------------------------+
  19. | :ref:`float<class_float>` | :ref:`float<class_float_method_float>` **(** :ref:`String<class_String>` from **)** |
  20. +---------------------------+-------------------------------------------------------------------------------------+
  21. Description
  22. -----------
  23. Float built-in type.
  24. Method Descriptions
  25. -------------------
  26. .. _class_float_method_float:
  27. - :ref:`float<class_float>` **float** **(** :ref:`bool<class_bool>` from **)**
  28. Cast a :ref:`bool<class_bool>` value to a floating point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0.
  29. ----
  30. - :ref:`float<class_float>` **float** **(** :ref:`int<class_int>` from **)**
  31. Cast an :ref:`int<class_int>` value to a floating point value, ``float(1)`` will be equal to 1.0.
  32. ----
  33. - :ref:`float<class_float>` **float** **(** :ref:`String<class_String>` from **)**
  34. Cast a :ref:`String<class_String>` value to a floating point value. This method accepts float value strings like ``"1.23"`` and exponential notation strings for its parameter so calling ``float("1e3")`` will return 1000.0 and calling ``float("1e-3")`` will return 0.001.