class_visualscripttypecast.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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 VisualScriptTypeCast.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptTypeCast:
  6. VisualScriptTypeCast
  7. ====================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. A Visual Script node that casts the given value to another type.
  10. Description
  11. -----------
  12. ``VisualScriptTypeCast`` will perform a type conversion to an :ref:`Object<class_Object>`-derived type.
  13. Properties
  14. ----------
  15. +-------------------------------------+---------------------------------------------------------------------+---------------+
  16. | :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptTypeCast_property_base_script>` | ``""`` |
  17. +-------------------------------------+---------------------------------------------------------------------+---------------+
  18. | :ref:`StringName<class_StringName>` | :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` | ``&"Object"`` |
  19. +-------------------------------------+---------------------------------------------------------------------+---------------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_VisualScriptTypeCast_property_base_script:
  23. - :ref:`String<class_String>` **base_script**
  24. +-----------+------------------------+
  25. | *Default* | ``""`` |
  26. +-----------+------------------------+
  27. | *Setter* | set_base_script(value) |
  28. +-----------+------------------------+
  29. | *Getter* | get_base_script() |
  30. +-----------+------------------------+
  31. The target script class to be converted to. If none, only the :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` will be used.
  32. ----
  33. .. _class_VisualScriptTypeCast_property_base_type:
  34. - :ref:`StringName<class_StringName>` **base_type**
  35. +-----------+----------------------+
  36. | *Default* | ``&"Object"`` |
  37. +-----------+----------------------+
  38. | *Setter* | set_base_type(value) |
  39. +-----------+----------------------+
  40. | *Getter* | get_base_type() |
  41. +-----------+----------------------+
  42. The target type to be converted to.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  46. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  47. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  48. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`