mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
87 lines
3.2 KiB
ReStructuredText
87 lines
3.2 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptComment.xml.
|
||
|
|
|
||
|
|
.. _class_VisualScriptComment:
|
||
|
|
|
||
|
|
VisualScriptComment
|
||
|
|
===================
|
||
|
|
|
||
|
|
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :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.)`
|