:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/VisualShaderNodeIntParameter.xml. .. _class_VisualShaderNodeIntParameter: VisualShaderNodeIntParameter ============================ **Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A visual shader node for shader parameter (uniform) of type :ref:`int`. .. rst-class:: classref-introduction-group Description ----------- A :ref:`VisualShaderNodeParameter` of type :ref:`int`. Offers additional customization for range of accepted values. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`default_value` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`default_value_enabled` | ``false`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ | :ref:`Hint` | :ref:`hint` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`max` | ``100`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`min` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`step` | ``1`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualShaderNodeIntParameter_Hint: .. rst-class:: classref-enumeration enum **Hint**: :ref:`🔗` .. _class_VisualShaderNodeIntParameter_constant_HINT_NONE: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_NONE** = ``0`` The parameter will not constrain its value. .. _class_VisualShaderNodeIntParameter_constant_HINT_RANGE: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_RANGE** = ``1`` The parameter's value must be within the specified :ref:`min`/:ref:`max` range. .. _class_VisualShaderNodeIntParameter_constant_HINT_RANGE_STEP: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_RANGE_STEP** = ``2`` The parameter's value must be within the specified range, with the given :ref:`step` between values. .. _class_VisualShaderNodeIntParameter_constant_HINT_MAX: .. rst-class:: classref-enumeration-constant :ref:`Hint` **HINT_MAX** = ``3`` Represents the size of the :ref:`Hint` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualShaderNodeIntParameter_property_default_value: .. rst-class:: classref-property :ref:`int` **default_value** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_default_value**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_default_value**\ (\ ) Default value of this parameter, which will be used if not set externally. :ref:`default_value_enabled` must be enabled; defaults to ``0`` otherwise. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeIntParameter_property_default_value_enabled: .. rst-class:: classref-property :ref:`bool` **default_value_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_default_value_enabled**\ (\ ) If ``true``, the node will have a custom default value. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeIntParameter_property_hint: .. rst-class:: classref-property :ref:`Hint` **hint** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_hint**\ (\ value\: :ref:`Hint`\ ) - :ref:`Hint` **get_hint**\ (\ ) Range hint of this node. Use it to customize valid parameter range. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeIntParameter_property_max: .. rst-class:: classref-property :ref:`int` **max** = ``100`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_max**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_max**\ (\ ) The maximum value this parameter can take. :ref:`hint` must be either :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP` for this to take effect. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeIntParameter_property_min: .. rst-class:: classref-property :ref:`int` **min** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_min**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_min**\ (\ ) The minimum value this parameter can take. :ref:`hint` must be either :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP` for this to take effect. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeIntParameter_property_step: .. rst-class:: classref-property :ref:`int` **step** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_step**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_step**\ (\ ) The step between parameter's values. Forces the parameter to be a multiple of the given value. :ref:`hint` must be :ref:`HINT_RANGE_STEP` for this to take effect. .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`