class_visualscriptconstant.rst 2.7 KB

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