virtualx-engine-docs/_sources/classes/class_visualscriptclassconstant.rst.txt

89 lines
3 KiB
Text
Raw Normal View History

2024-10-23 18:41:33 +02:00
:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptClassConstant.xml.
.. _class_VisualScriptClassConstant:
VisualScriptClassConstant
=========================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Gets a constant from a given class.
.. rst-class:: classref-introduction-group
Description
-----------
This node returns a constant from a given class, such as :ref:`@GlobalScope.TYPE_INT<class_@GlobalScope_constant_TYPE_INT>`. See the given class' documentation for available constants.
\ **Input Ports:**\
none
\ **Output Ports:**\
- Data (variant): ``value``
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-----------------------------+----------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``"Object"`` |
+-----------------------------+----------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` | ``""`` |
+-----------------------------+----------------------------------------------------------------------+--------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualScriptClassConstant_property_base_type:
.. rst-class:: classref-property
:ref:`String<class_String>` **base_type** = ``"Object"``
.. rst-class:: classref-property-setget
- void **set_base_type** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_base_type** **(** **)**
The constant's parent class.
.. rst-class:: classref-item-separator
----
.. _class_VisualScriptClassConstant_property_constant:
.. rst-class:: classref-property
:ref:`String<class_String>` **constant** = ``""``
.. rst-class:: classref-property-setget
- void **set_class_constant** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_class_constant** **(** **)**
The constant to return. See the given class for its available constants.
.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`