godot-docs/classes/class_visualscriptclassconstant.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptClassConstant.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisualScriptClassConstant:

VisualScriptClassConstant
=========================

**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :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:`StringName<class_StringName>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``&"Object"`` |
+-------------------------------------+----------------------------------------------------------------------+---------------+
| :ref:`StringName<class_StringName>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>`   | ``&""``       |
+-------------------------------------+----------------------------------------------------------------------+---------------+

Property Descriptions
---------------------

.. _class_VisualScriptClassConstant_property_base_type:

- :ref:`StringName<class_StringName>` **base_type**

+-----------+----------------------+
| *Default* | ``&"Object"``        |
+-----------+----------------------+
| *Setter*  | set_base_type(value) |
+-----------+----------------------+
| *Getter*  | get_base_type()      |
+-----------+----------------------+

The constant's parent class.

----

.. _class_VisualScriptClassConstant_property_constant:

- :ref:`StringName<class_StringName>` **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.)`
.. |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.)`