class_bool.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 bool.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_bool:
  6. bool
  7. ====
  8. **Category:** Built-In Types
  9. Brief Description
  10. -----------------
  11. Boolean built-in type
  12. Methods
  13. -------
  14. +-------------------------+----------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`bool<class_bool_method_bool>` **(** :ref:`int<class_int>` from **)** |
  16. +-------------------------+----------------------------------------------------------------------------------+
  17. | :ref:`bool<class_bool>` | :ref:`bool<class_bool_method_bool>` **(** :ref:`float<class_float>` from **)** |
  18. +-------------------------+----------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`bool<class_bool_method_bool>` **(** :ref:`String<class_String>` from **)** |
  20. +-------------------------+----------------------------------------------------------------------------------+
  21. Description
  22. -----------
  23. Boolean built-in type.
  24. Method Descriptions
  25. -------------------
  26. .. _class_bool_method_bool:
  27. - :ref:`bool<class_bool>` **bool** **(** :ref:`int<class_int>` from **)**
  28. Cast an :ref:`int<class_int>` value to a boolean value, this method will return ``true`` if called with an integer value different to 0 and ``false`` in other case.
  29. ----
  30. - :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)**
  31. Cast a :ref:`float<class_float>` value to a boolean value, this method will return ``true`` if called with a floating point value different to 0 and ``false`` in other case.
  32. ----
  33. - :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_String>` from **)**
  34. Cast a :ref:`String<class_String>` value to a boolean value, this method will return ``true`` if called with a non empty string and ``false`` in other case. Examples: ``bool('False')`` returns ``true``, ``bool('')`` returns ``false``.