class_visualscriptconstant.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScriptConstant.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScriptConstant:
  5. VisualScriptConstant
  6. ====================
  7. **Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A Visual Script node which returns a constant value.
  12. Member Functions
  13. ----------------
  14. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_constant_type<class_VisualScriptConstant_get_constant_type>` **(** **)** const |
  16. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Variant<class_variant>` | :ref:`get_constant_value<class_VisualScriptConstant_get_constant_value>` **(** **)** const |
  18. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_constant_type<class_VisualScriptConstant_set_constant_type>` **(** :ref:`int<class_int>` type **)** |
  20. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_constant_value<class_VisualScriptConstant_set_constant_value>` **(** :ref:`Variant<class_variant>` value **)** |
  22. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  23. Member Variables
  24. ----------------
  25. - :ref:`int<class_int>` **type** - The constant's type.
  26. - :ref:`Variant<class_variant>` **value** - The constant's value.
  27. Description
  28. -----------
  29. A Visual Script node which returns the specified constant value.
  30. Member Function Description
  31. ---------------------------
  32. .. _class_VisualScriptConstant_get_constant_type:
  33. - :ref:`int<class_int>` **get_constant_type** **(** **)** const
  34. .. _class_VisualScriptConstant_get_constant_value:
  35. - :ref:`Variant<class_variant>` **get_constant_value** **(** **)** const
  36. .. _class_VisualScriptConstant_set_constant_type:
  37. - void **set_constant_type** **(** :ref:`int<class_int>` type **)**
  38. .. _class_VisualScriptConstant_set_constant_value:
  39. - void **set_constant_value** **(** :ref:`Variant<class_variant>` value **)**