class_visualscriptcomment.rst 1.1 KB

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