Files
godot-docs/classes/class_visualshadernodebooleanconstant.rst
2023-05-19 13:35:34 +00:00

66 lines
2.5 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/VisualShaderNodeBooleanConstant.xml.
.. _class_VisualShaderNodeBooleanConstant:
VisualShaderNodeBooleanConstant
===============================
**Inherits:** :ref:`VisualShaderNodeConstant<class_VisualShaderNodeConstant>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A boolean constant to be used within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
Has only one output port and no inputs.
Translated to ``bool`` in the shader language.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------+--------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`constant<class_VisualShaderNodeBooleanConstant_property_constant>` | ``false`` |
+-------------------------+--------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeBooleanConstant_property_constant:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **constant** = ``false``
.. rst-class:: classref-property-setget
- void **set_constant** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_constant** **(** **)**
A boolean constant which represents a state of this node.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`