Files
godot-docs/classes/class_visualshadernodebooleanconstant.rst
2020-09-15 15:09:00 +02:00

50 lines
1.9 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeBooleanConstant.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeBooleanConstant:
VisualShaderNodeBooleanConstant
===============================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
A boolean constant to be used within the visual shader graph.
Description
-----------
Has only one output port and no inputs.
Translated to ``bool`` in the shader language.
Properties
----------
+-------------------------+--------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`constant<class_VisualShaderNodeBooleanConstant_property_constant>` | ``false`` |
+-------------------------+--------------------------------------------------------------------------+-----------+
Property Descriptions
---------------------
.. _class_VisualShaderNodeBooleanConstant_property_constant:
- :ref:`bool<class_bool>` **constant**
+-----------+---------------------+
| *Default* | ``false`` |
+-----------+---------------------+
| *Setter* | set_constant(value) |
+-----------+---------------------+
| *Getter* | 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.)`