pandemonium_engine_docs/classes/class_visualscriptclassconstant.rst

75 lines
2.7 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/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.
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``
Properties
----------
+-----------------------------+----------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``"Object"`` |
+-----------------------------+----------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` | ``""`` |
+-----------------------------+----------------------------------------------------------------------+--------------+
Property Descriptions
---------------------
.. _class_VisualScriptClassConstant_property_base_type:
- :ref:`String<class_String>` **base_type**
+-----------+----------------------+
| *Default* | ``"Object"`` |
+-----------+----------------------+
| *Setter* | set_base_type(value) |
+-----------+----------------------+
| *Getter* | get_base_type() |
+-----------+----------------------+
The constant's parent class.
----
.. _class_VisualScriptClassConstant_property_constant:
- :ref:`String<class_String>` **constant**
+-----------+---------------------------+
| *Default* | ``""`` |
+-----------+---------------------------+
| *Setter* | set_class_constant(value) |
+-----------+---------------------------+
| *Getter* | 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.)`