class_inputeventmousemotion.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the InputEventMouseMotion.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_InputEventMouseMotion:
  5. InputEventMouseMotion
  6. =====================
  7. **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>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Input event type for mouse motion events.
  12. Member Functions
  13. ----------------
  14. +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Vector2<class_vector2>` | :ref:`get_relative<class_InputEventMouseMotion_get_relative>` **(** **)** const |
  16. +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Vector2<class_vector2>` | :ref:`get_speed<class_InputEventMouseMotion_get_speed>` **(** **)** const |
  18. +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_relative<class_InputEventMouseMotion_set_relative>` **(** :ref:`Vector2<class_vector2>` relative **)** |
  20. +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_speed<class_InputEventMouseMotion_set_speed>` **(** :ref:`Vector2<class_vector2>` speed **)** |
  22. +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
  23. Member Variables
  24. ----------------
  25. - :ref:`Vector2<class_vector2>` **relative** - Position of the mouse pointer relative to the previous mouse position.
  26. - :ref:`Vector2<class_vector2>` **speed** - Speed of the mouse pointer.
  27. Member Function Description
  28. ---------------------------
  29. .. _class_InputEventMouseMotion_get_relative:
  30. - :ref:`Vector2<class_vector2>` **get_relative** **(** **)** const
  31. .. _class_InputEventMouseMotion_get_speed:
  32. - :ref:`Vector2<class_vector2>` **get_speed** **(** **)** const
  33. .. _class_InputEventMouseMotion_set_relative:
  34. - void **set_relative** **(** :ref:`Vector2<class_vector2>` relative **)**
  35. .. _class_InputEventMouseMotion_set_speed:
  36. - void **set_speed** **(** :ref:`Vector2<class_vector2>` speed **)**