class_bool.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the bool.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_bool:
  5. bool
  6. ====
  7. **Category:** Built-In Types
  8. Brief Description
  9. -----------------
  10. Boolean built-in type
  11. Member Functions
  12. ----------------
  13. +--------------------------+---------------------------------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`int<class_int>` from **)** |
  15. +--------------------------+---------------------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`float<class_float>` from **)** |
  17. +--------------------------+---------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`String<class_string>` from **)** |
  19. +--------------------------+---------------------------------------------------------------------------+
  20. Description
  21. -----------
  22. Boolean built-in type.
  23. Member Function Description
  24. ---------------------------
  25. .. _class_bool_bool:
  26. - :ref:`bool<class_bool>` **bool** **(** :ref:`int<class_int>` from **)**
  27. 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.
  28. .. _class_bool_bool:
  29. - :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)**
  30. 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.
  31. .. _class_bool_bool:
  32. - :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_string>` from **)**
  33. 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