Files
godot-docs/classes/class_visualshadernodeswitch.rst
2025-06-07 03:33:02 +00:00

154 lines
5.0 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSwitch.xml.
.. _class_VisualShaderNodeSwitch:
VisualShaderNodeSwitch
======================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A selector function for use within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
Returns an associated value of the :ref:`op_type<class_VisualShaderNodeSwitch_property_op_type>` type if the provided boolean value is ``true`` or ``false``.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------------------------------+---------------------------------------------------------------+-------+
| :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` | :ref:`op_type<class_VisualShaderNodeSwitch_property_op_type>` | ``0`` |
+---------------------------------------------------+---------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeSwitch_OpType:
.. rst-class:: classref-enumeration
enum **OpType**: :ref:`🔗<enum_VisualShaderNodeSwitch_OpType>`
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_FLOAT:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_FLOAT** = ``0``
A floating-point scalar.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_INT:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_INT** = ``1``
An integer scalar.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_UINT:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_UINT** = ``2``
An unsigned integer scalar.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_2D:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_VECTOR_2D** = ``3``
A 2D vector type.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_3D:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_VECTOR_3D** = ``4``
A 3D vector type.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_VECTOR_4D:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_VECTOR_4D** = ``5``
A 4D vector type.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_BOOLEAN:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_BOOLEAN** = ``6``
A boolean type.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_TRANSFORM:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_TRANSFORM** = ``7``
A transform type.
.. _class_VisualShaderNodeSwitch_constant_OP_TYPE_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **OP_TYPE_MAX** = ``8``
Represents the size of the :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` enum.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeSwitch_property_op_type:
.. rst-class:: classref-property
:ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **op_type** = ``0`` :ref:`🔗<class_VisualShaderNodeSwitch_property_op_type>`
.. rst-class:: classref-property-setget
- |void| **set_op_type**\ (\ value\: :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>`\ )
- :ref:`OpType<enum_VisualShaderNodeSwitch_OpType>` **get_op_type**\ (\ )
A type of operands and returned value.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`