class_inputeventmousemotion.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the InputEventMouseMotion.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_InputEventMouseMotion:
  6. InputEventMouseMotion
  7. =====================
  8. **Inherits:** :ref:`InputEventMouse<class_InputEventMouse>` **<** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Input event type for mouse motion events.
  13. Properties
  14. ----------
  15. +-------------------------------+----------------------------------------------------------------+
  16. | :ref:`Vector2<class_Vector2>` | :ref:`relative<class_InputEventMouseMotion_property_relative>` |
  17. +-------------------------------+----------------------------------------------------------------+
  18. | :ref:`Vector2<class_Vector2>` | :ref:`speed<class_InputEventMouseMotion_property_speed>` |
  19. +-------------------------------+----------------------------------------------------------------+
  20. Description
  21. -----------
  22. Contains mouse motion information. Supports relative, absolute positions and speed. See :ref:`Node._input<class_Node_method__input>`.
  23. Tutorials
  24. ---------
  25. - :doc:`../tutorials/inputs/mouse_and_input_coordinates`
  26. Property Descriptions
  27. ---------------------
  28. .. _class_InputEventMouseMotion_property_relative:
  29. - :ref:`Vector2<class_Vector2>` **relative**
  30. +----------+---------------------+
  31. | *Setter* | set_relative(value) |
  32. +----------+---------------------+
  33. | *Getter* | get_relative() |
  34. +----------+---------------------+
  35. Mouse position relative to the previous position (position at the last frame).
  36. ----
  37. .. _class_InputEventMouseMotion_property_speed:
  38. - :ref:`Vector2<class_Vector2>` **speed**
  39. +----------+------------------+
  40. | *Setter* | set_speed(value) |
  41. +----------+------------------+
  42. | *Getter* | get_speed() |
  43. +----------+------------------+
  44. Mouse speed.