Files
godot-docs/classes/class_visualshadernodecompare.rst
Rémi Verschelde 2b4319bc29 Sync classref with current source
Changes order of brief/long descriptions and removes category
as per godotengine/godot#35132.
2020-01-15 00:51:47 +01:00

139 lines
4.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCompare.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeCompare:
VisualShaderNodeCompare
=======================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Properties
----------
+--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+
| :ref:`Condition<enum_VisualShaderNodeCompare_Condition>` | :ref:`condition<class_VisualShaderNodeCompare_property_condition>` | 0 |
+--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+
| :ref:`Array<class_Array>` | default_input_values | **O:** [ 0, 0.0, 1, 0.0, 2, 1e-05 ] |
+--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+
| :ref:`Function<enum_VisualShaderNodeCompare_Function>` | :ref:`function<class_VisualShaderNodeCompare_property_function>` | 0 |
+--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+
| :ref:`ComparsionType<enum_VisualShaderNodeCompare_ComparsionType>` | :ref:`type<class_VisualShaderNodeCompare_property_type>` | 0 |
+--------------------------------------------------------------------+--------------------------------------------------------------------+-------------------------------------+
Enumerations
------------
.. _enum_VisualShaderNodeCompare_ComparsionType:
.. _class_VisualShaderNodeCompare_constant_CTYPE_SCALAR:
.. _class_VisualShaderNodeCompare_constant_CTYPE_VECTOR:
.. _class_VisualShaderNodeCompare_constant_CTYPE_BOOLEAN:
.. _class_VisualShaderNodeCompare_constant_CTYPE_TRANSFORM:
enum **ComparsionType**:
- **CTYPE_SCALAR** = **0**
- **CTYPE_VECTOR** = **1**
- **CTYPE_BOOLEAN** = **2**
- **CTYPE_TRANSFORM** = **3**
----
.. _enum_VisualShaderNodeCompare_Function:
.. _class_VisualShaderNodeCompare_constant_FUNC_EQUAL:
.. _class_VisualShaderNodeCompare_constant_FUNC_NOT_EQUAL:
.. _class_VisualShaderNodeCompare_constant_FUNC_GREATER_THAN:
.. _class_VisualShaderNodeCompare_constant_FUNC_GREATER_THAN_EQUAL:
.. _class_VisualShaderNodeCompare_constant_FUNC_LESS_THAN:
.. _class_VisualShaderNodeCompare_constant_FUNC_LESS_THAN_EQUAL:
enum **Function**:
- **FUNC_EQUAL** = **0**
- **FUNC_NOT_EQUAL** = **1**
- **FUNC_GREATER_THAN** = **2**
- **FUNC_GREATER_THAN_EQUAL** = **3**
- **FUNC_LESS_THAN** = **4**
- **FUNC_LESS_THAN_EQUAL** = **5**
----
.. _enum_VisualShaderNodeCompare_Condition:
.. _class_VisualShaderNodeCompare_constant_COND_ALL:
.. _class_VisualShaderNodeCompare_constant_COND_ANY:
enum **Condition**:
- **COND_ALL** = **0**
- **COND_ANY** = **1**
Property Descriptions
---------------------
.. _class_VisualShaderNodeCompare_property_condition:
- :ref:`Condition<enum_VisualShaderNodeCompare_Condition>` **condition**
+-----------+----------------------+
| *Default* | 0 |
+-----------+----------------------+
| *Setter* | set_condition(value) |
+-----------+----------------------+
| *Getter* | get_condition() |
+-----------+----------------------+
----
.. _class_VisualShaderNodeCompare_property_function:
- :ref:`Function<enum_VisualShaderNodeCompare_Function>` **function**
+-----------+---------------------+
| *Default* | 0 |
+-----------+---------------------+
| *Setter* | set_function(value) |
+-----------+---------------------+
| *Getter* | get_function() |
+-----------+---------------------+
----
.. _class_VisualShaderNodeCompare_property_type:
- :ref:`ComparsionType<enum_VisualShaderNodeCompare_ComparsionType>` **type**
+-----------+----------------------------+
| *Default* | 0 |
+-----------+----------------------------+
| *Setter* | set_comparsion_type(value) |
+-----------+----------------------------+
| *Getter* | get_comparsion_type() |
+-----------+----------------------------+