Files
godot-docs/classes/class_visualscriptcomment.rst
2017-11-27 08:32:15 +01:00

42 lines
1.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptComment.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptComment:
VisualScriptComment
===================
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
A Visual Script node used to annotate the script.
Member Variables
----------------
.. _class_VisualScriptComment_description:
- :ref:`String<class_string>` **description** - The text inside the comment node.
.. _class_VisualScriptComment_size:
- :ref:`Vector2<class_vector2>` **size** - The comment node's size (in pixels).
.. _class_VisualScriptComment_title:
- :ref:`String<class_string>` **title** - The comment node's title.
Description
-----------
A Visual Script node used to display annotations in the script, so that code may be documented.
Comment nodes can be resized so they encompass a group of nodes.