| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/4.1/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/4.1/doc/classes/VisualShaderNodeComment.xml.
- .. _class_VisualShaderNodeComment:
- VisualShaderNodeComment
- =======================
- **Inherits:** :ref:`VisualShaderNodeResizableBase<class_VisualShaderNodeResizableBase>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A comment node to be placed on visual shader graph.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- A resizable rectangular area with changeable :ref:`title<class_VisualShaderNodeComment_property_title>` and :ref:`description<class_VisualShaderNodeComment_property_description>` used for better organizing of other visual shader nodes.
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-----------------------------+------------------------------------------------------------------------+---------------+
- | :ref:`String<class_String>` | :ref:`description<class_VisualShaderNodeComment_property_description>` | ``""`` |
- +-----------------------------+------------------------------------------------------------------------+---------------+
- | :ref:`String<class_String>` | :ref:`title<class_VisualShaderNodeComment_property_title>` | ``"Comment"`` |
- +-----------------------------+------------------------------------------------------------------------+---------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_VisualShaderNodeComment_property_description:
- .. rst-class:: classref-property
- :ref:`String<class_String>` **description** = ``""``
- .. rst-class:: classref-property-setget
- - void **set_description** **(** :ref:`String<class_String>` value **)**
- - :ref:`String<class_String>` **get_description** **(** **)**
- An additional description which placed below the title.
- .. rst-class:: classref-item-separator
- ----
- .. _class_VisualShaderNodeComment_property_title:
- .. rst-class:: classref-property
- :ref:`String<class_String>` **title** = ``"Comment"``
- .. rst-class:: classref-property-setget
- - void **set_title** **(** :ref:`String<class_String>` value **)**
- - :ref:`String<class_String>` **get_title** **(** **)**
- A title of the 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.)`
- .. |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.)`
|
