class_visualscriptconstant.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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/VisualScriptConstant.xml.
  6. .. _class_VisualScriptConstant:
  7. VisualScriptConstant
  8. ====================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Gets a contant's value.
  11. Description
  12. -----------
  13. This node returns a constant's value.
  14. \ **Input Ports:**\
  15. none
  16. \ **Output Ports:**\
  17. - Data (variant): ``get``
  18. Properties
  19. ----------
  20. +-----------------------------------------------------+---------------------------------------------------------+-------+
  21. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptConstant_property_type>` | ``0`` |
  22. +-----------------------------------------------------+---------------------------------------------------------+-------+
  23. | :ref:`Variant<class_Variant>` | :ref:`value<class_VisualScriptConstant_property_value>` | |
  24. +-----------------------------------------------------+---------------------------------------------------------+-------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualScriptConstant_property_type:
  28. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
  29. +-----------+--------------------------+
  30. | *Default* | ``0`` |
  31. +-----------+--------------------------+
  32. | *Setter* | set_constant_type(value) |
  33. +-----------+--------------------------+
  34. | *Getter* | get_constant_type() |
  35. +-----------+--------------------------+
  36. The constant's type.
  37. ----
  38. .. _class_VisualScriptConstant_property_value:
  39. - :ref:`Variant<class_Variant>` **value**
  40. +----------+---------------------------+
  41. | *Setter* | set_constant_value(value) |
  42. +----------+---------------------------+
  43. | *Getter* | get_constant_value() |
  44. +----------+---------------------------+
  45. The constant's value.
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  49. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  50. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  51. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`