mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
89 lines
3.5 KiB
ReStructuredText
89 lines
3.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A Visual Script node used to annotate the script.
|
|
|
|
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.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`String<class_String>` | :ref:`description<class_VisualScriptComment_property_description>` | ``""`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_VisualScriptComment_property_size>` | ``Vector2(150, 150)`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
| :ref:`String<class_String>` | :ref:`title<class_VisualScriptComment_property_title>` | ``"Comment"`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-----------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualScriptComment_property_description:
|
|
|
|
- :ref:`String<class_String>` **description**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_description(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_description() |
|
|
+-----------+------------------------+
|
|
|
|
The text inside the comment node.
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptComment_property_size:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **size**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``Vector2(150, 150)`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_size(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_size() |
|
|
+-----------+-----------------------+
|
|
|
|
The comment node's size (in pixels).
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptComment_property_title:
|
|
|
|
- :ref:`String<class_String>` **title**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``"Comment"`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_title(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_title() |
|
|
+-----------+------------------+
|
|
|
|
The comment node's title.
|
|
|
|
.. |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.)`
|