2
0

class_visualscriptclassconstant.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptClassConstant.xml.
  6. .. _class_VisualScriptClassConstant:
  7. VisualScriptClassConstant
  8. =========================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Gets a constant from a given class.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. 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.
  15. \ **Input Ports:**\
  16. none
  17. \ **Output Ports:**\
  18. - Data (variant): ``value``
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +-----------------------------+----------------------------------------------------------------------+--------------+
  25. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``"Object"`` |
  26. +-----------------------------+----------------------------------------------------------------------+--------------+
  27. | :ref:`String<class_String>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` | ``""`` |
  28. +-----------------------------+----------------------------------------------------------------------+--------------+
  29. .. rst-class:: classref-section-separator
  30. ----
  31. .. rst-class:: classref-descriptions-group
  32. Property Descriptions
  33. ---------------------
  34. .. _class_VisualScriptClassConstant_property_base_type:
  35. .. rst-class:: classref-property
  36. :ref:`String<class_String>` **base_type** = ``"Object"``
  37. .. rst-class:: classref-property-setget
  38. - void **set_base_type** **(** :ref:`String<class_String>` value **)**
  39. - :ref:`String<class_String>` **get_base_type** **(** **)**
  40. The constant's parent class.
  41. .. rst-class:: classref-item-separator
  42. ----
  43. .. _class_VisualScriptClassConstant_property_constant:
  44. .. rst-class:: classref-property
  45. :ref:`String<class_String>` **constant** = ``""``
  46. .. rst-class:: classref-property-setget
  47. - void **set_class_constant** **(** :ref:`String<class_String>` value **)**
  48. - :ref:`String<class_String>` **get_class_constant** **(** **)**
  49. The constant to return. See the given class for its available constants.
  50. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  51. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  52. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  53. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`