class_visualscriptoperator.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/VisualScriptOperator.xml.
  6. .. _class_VisualScriptOperator:
  7. VisualScriptOperator
  8. ====================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A Visual Script node that performs an operation on two values.
  11. Description
  12. -----------
  13. **Input Ports:**\
  14. - Data (variant): ``A``\
  15. - Data (variant): ``B``\
  16. \ **Output Ports:**\
  17. - Data (variant): ``result``
  18. Properties
  19. ----------
  20. +-------------------------------------------------------------+---------------------------------------------------------------+-------+
  21. | :ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` | :ref:`operator<class_VisualScriptOperator_property_operator>` | ``6`` |
  22. +-------------------------------------------------------------+---------------------------------------------------------------+-------+
  23. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptOperator_property_type>` | ``0`` |
  24. +-------------------------------------------------------------+---------------------------------------------------------------+-------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualScriptOperator_property_operator:
  28. - :ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **operator**
  29. +-----------+---------------------+
  30. | *Default* | ``6`` |
  31. +-----------+---------------------+
  32. | *Setter* | set_operator(value) |
  33. +-----------+---------------------+
  34. | *Getter* | get_operator() |
  35. +-----------+---------------------+
  36. The operation to be performed. See :ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` for available options.
  37. ----
  38. .. _class_VisualScriptOperator_property_type:
  39. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
  40. +-----------+------------------+
  41. | *Default* | ``0`` |
  42. +-----------+------------------+
  43. | *Setter* | set_typed(value) |
  44. +-----------+------------------+
  45. | *Getter* | get_typed() |
  46. +-----------+------------------+
  47. The type of the values for this operation. See :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` for available options.
  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.)`