class_visualscriptcomment.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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. Properties
  13. ----------
  14. +-------------------------------+--------------------------------------------------------------------+
  15. | :ref:`String<class_String>` | :ref:`description<class_VisualScriptComment_property_description>` |
  16. +-------------------------------+--------------------------------------------------------------------+
  17. | :ref:`Vector2<class_Vector2>` | :ref:`size<class_VisualScriptComment_property_size>` |
  18. +-------------------------------+--------------------------------------------------------------------+
  19. | :ref:`String<class_String>` | :ref:`title<class_VisualScriptComment_property_title>` |
  20. +-------------------------------+--------------------------------------------------------------------+
  21. Description
  22. -----------
  23. A Visual Script node used to display annotations in the script, so that code may be documented.
  24. Comment nodes can be resized so they encompass a group of nodes.
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualScriptComment_property_description:
  28. - :ref:`String<class_String>` **description**
  29. +----------+------------------------+
  30. | *Setter* | set_description(value) |
  31. +----------+------------------------+
  32. | *Getter* | get_description() |
  33. +----------+------------------------+
  34. The text inside the comment node.
  35. .. _class_VisualScriptComment_property_size:
  36. - :ref:`Vector2<class_Vector2>` **size**
  37. +----------+-----------------+
  38. | *Setter* | set_size(value) |
  39. +----------+-----------------+
  40. | *Getter* | get_size() |
  41. +----------+-----------------+
  42. The comment node's size (in pixels).
  43. .. _class_VisualScriptComment_property_title:
  44. - :ref:`String<class_String>` **title**
  45. +----------+------------------+
  46. | *Setter* | set_title(value) |
  47. +----------+------------------+
  48. | *Getter* | get_title() |
  49. +----------+------------------+
  50. The comment node's title.