class_visualshadernodebooleanconstant.rst 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeBooleanConstant.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeBooleanConstant:
  6. VisualShaderNodeBooleanConstant
  7. ===============================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. A boolean constant to be used within the visual shader graph.
  10. Description
  11. -----------
  12. Has only one output port and no inputs.
  13. Translated to ``bool`` in the shader language.
  14. Properties
  15. ----------
  16. +-------------------------+--------------------------------------------------------------------------+-----------+
  17. | :ref:`bool<class_bool>` | :ref:`constant<class_VisualShaderNodeBooleanConstant_property_constant>` | ``false`` |
  18. +-------------------------+--------------------------------------------------------------------------+-----------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_VisualShaderNodeBooleanConstant_property_constant:
  22. - :ref:`bool<class_bool>` **constant**
  23. +-----------+---------------------+
  24. | *Default* | ``false`` |
  25. +-----------+---------------------+
  26. | *Setter* | set_constant(value) |
  27. +-----------+---------------------+
  28. | *Getter* | get_constant() |
  29. +-----------+---------------------+
  30. A boolean constant which represents a state of this node.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`