class_visualscriptclassconstant.rst 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualScriptClassConstant.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptClassConstant:
  6. VisualScriptClassConstant
  7. =========================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Gets a constant from a given class.
  10. Description
  11. -----------
  12. 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.
  13. **Input Ports:**
  14. none
  15. **Output Ports:**
  16. - Data (variant): ``value``
  17. Properties
  18. ----------
  19. +-------------------------------------+----------------------------------------------------------------------+---------------+
  20. | :ref:`StringName<class_StringName>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``@"Object"`` |
  21. +-------------------------------------+----------------------------------------------------------------------+---------------+
  22. | :ref:`StringName<class_StringName>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` | ``@""`` |
  23. +-------------------------------------+----------------------------------------------------------------------+---------------+
  24. Property Descriptions
  25. ---------------------
  26. .. _class_VisualScriptClassConstant_property_base_type:
  27. - :ref:`StringName<class_StringName>` **base_type**
  28. +-----------+----------------------+
  29. | *Default* | ``@"Object"`` |
  30. +-----------+----------------------+
  31. | *Setter* | set_base_type(value) |
  32. +-----------+----------------------+
  33. | *Getter* | get_base_type() |
  34. +-----------+----------------------+
  35. The constant's parent class.
  36. ----
  37. .. _class_VisualScriptClassConstant_property_constant:
  38. - :ref:`StringName<class_StringName>` **constant**
  39. +-----------+---------------------------+
  40. | *Default* | ``@""`` |
  41. +-----------+---------------------------+
  42. | *Setter* | set_class_constant(value) |
  43. +-----------+---------------------------+
  44. | *Getter* | get_class_constant() |
  45. +-----------+---------------------------+
  46. The constant to return. See the given class for its available constants.