class_visualscriptclassconstant.rst 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptClassConstant.xml.
  6. .. _class_VisualScriptClassConstant:
  7. VisualScriptClassConstant
  8. =========================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Gets a constant from a given class.
  11. Description
  12. -----------
  13. 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.
  14. \ **Input Ports:**\
  15. none
  16. \ **Output Ports:**\
  17. - Data (variant): ``value``
  18. Properties
  19. ----------
  20. +-------------------------------------+----------------------------------------------------------------------+---------------+
  21. | :ref:`StringName<class_StringName>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``&"Object"`` |
  22. +-------------------------------------+----------------------------------------------------------------------+---------------+
  23. | :ref:`StringName<class_StringName>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` | ``&""`` |
  24. +-------------------------------------+----------------------------------------------------------------------+---------------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualScriptClassConstant_property_base_type:
  28. - :ref:`StringName<class_StringName>` **base_type**
  29. +-----------+----------------------+
  30. | *Default* | ``&"Object"`` |
  31. +-----------+----------------------+
  32. | *Setter* | set_base_type(value) |
  33. +-----------+----------------------+
  34. | *Getter* | get_base_type() |
  35. +-----------+----------------------+
  36. The constant's parent class.
  37. ----
  38. .. _class_VisualScriptClassConstant_property_constant:
  39. - :ref:`StringName<class_StringName>` **constant**
  40. +-----------+---------------------------+
  41. | *Default* | ``&""`` |
  42. +-----------+---------------------------+
  43. | *Setter* | set_class_constant(value) |
  44. +-----------+---------------------------+
  45. | *Getter* | get_class_constant() |
  46. +-----------+---------------------------+
  47. The constant to return. See the given class for its available constants.
  48. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  49. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  50. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  51. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  52. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  53. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`