Files
godot-docs/classes/class_visualshadernodeintparameter.rst
2022-09-09 15:22:52 +02:00

148 lines
6.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/VisualShaderNodeIntParameter.xml.
.. _class_VisualShaderNodeIntParameter:
VisualShaderNodeIntParameter
============================
**Inherits:** :ref:`VisualShaderNodeParameter<class_VisualShaderNodeParameter>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Properties
----------
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`default_value<class_VisualShaderNodeIntParameter_property_default_value>` | ``0`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`default_value_enabled<class_VisualShaderNodeIntParameter_property_default_value_enabled>` | ``false`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
| :ref:`Hint<enum_VisualShaderNodeIntParameter_Hint>` | :ref:`hint<class_VisualShaderNodeIntParameter_property_hint>` | ``0`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`max<class_VisualShaderNodeIntParameter_property_max>` | ``100`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`min<class_VisualShaderNodeIntParameter_property_min>` | ``0`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`step<class_VisualShaderNodeIntParameter_property_step>` | ``1`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+
Enumerations
------------
.. _enum_VisualShaderNodeIntParameter_Hint:
.. _class_VisualShaderNodeIntParameter_constant_HINT_NONE:
.. _class_VisualShaderNodeIntParameter_constant_HINT_RANGE:
.. _class_VisualShaderNodeIntParameter_constant_HINT_RANGE_STEP:
.. _class_VisualShaderNodeIntParameter_constant_HINT_MAX:
enum **Hint**:
- **HINT_NONE** = **0**
- **HINT_RANGE** = **1**
- **HINT_RANGE_STEP** = **2**
- **HINT_MAX** = **3**
Property Descriptions
---------------------
.. _class_VisualShaderNodeIntParameter_property_default_value:
- :ref:`int<class_int>` **default_value**
+-----------+--------------------------+
| *Default* | ``0`` |
+-----------+--------------------------+
| *Setter* | set_default_value(value) |
+-----------+--------------------------+
| *Getter* | get_default_value() |
+-----------+--------------------------+
----
.. _class_VisualShaderNodeIntParameter_property_default_value_enabled:
- :ref:`bool<class_bool>` **default_value_enabled**
+-----------+----------------------------------+
| *Default* | ``false`` |
+-----------+----------------------------------+
| *Setter* | set_default_value_enabled(value) |
+-----------+----------------------------------+
| *Getter* | is_default_value_enabled() |
+-----------+----------------------------------+
----
.. _class_VisualShaderNodeIntParameter_property_hint:
- :ref:`Hint<enum_VisualShaderNodeIntParameter_Hint>` **hint**
+-----------+-----------------+
| *Default* | ``0`` |
+-----------+-----------------+
| *Setter* | set_hint(value) |
+-----------+-----------------+
| *Getter* | get_hint() |
+-----------+-----------------+
----
.. _class_VisualShaderNodeIntParameter_property_max:
- :ref:`int<class_int>` **max**
+-----------+----------------+
| *Default* | ``100`` |
+-----------+----------------+
| *Setter* | set_max(value) |
+-----------+----------------+
| *Getter* | get_max() |
+-----------+----------------+
----
.. _class_VisualShaderNodeIntParameter_property_min:
- :ref:`int<class_int>` **min**
+-----------+----------------+
| *Default* | ``0`` |
+-----------+----------------+
| *Setter* | set_min(value) |
+-----------+----------------+
| *Getter* | get_min() |
+-----------+----------------+
----
.. _class_VisualShaderNodeIntParameter_property_step:
- :ref:`int<class_int>` **step**
+-----------+-----------------+
| *Default* | ``1`` |
+-----------+-----------------+
| *Setter* | set_step(value) |
+-----------+-----------------+
| *Getter* | get_step() |
+-----------+-----------------+
.. |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.)`