InputEventMouseMotion.xml 2.2 KB

123456789101112131415161718192021222324252627282930313233
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="InputEventMouseMotion" inherits="InputEventMouse" version="3.3">
  3. <brief_description>
  4. Input event type for mouse motion events.
  5. </brief_description>
  6. <description>
  7. Contains mouse and pen motion information. Supports relative, absolute positions and speed. See [method Node._input].
  8. [b]Note:[/b] By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, call [method Input.set_use_accumulated_input] with [code]false[/code] to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing [url=https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm]Bresenham's line algorithm[/url] as well to avoid visible gaps in lines if the user is moving the mouse quickly.
  9. </description>
  10. <tutorials>
  11. <link title="Mouse and input coordinates">https://docs.godotengine.org/en/3.3/tutorials/inputs/mouse_and_input_coordinates.html</link>
  12. <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
  13. </tutorials>
  14. <methods>
  15. </methods>
  16. <members>
  17. <member name="pressure" type="float" setter="set_pressure" getter="get_pressure" default="0.0">
  18. Represents the pressure the user puts on the pen. Ranges from [code]0.0[/code] to [code]1.0[/code].
  19. </member>
  20. <member name="relative" type="Vector2" setter="set_relative" getter="get_relative" default="Vector2( 0, 0 )">
  21. The mouse position relative to the previous position (position at the last frame).
  22. [b]Note:[/b] Since [InputEventMouseMotion] is only emitted when the mouse moves, the last event won't have a relative position of [code]Vector2(0, 0)[/code] when the user stops moving the mouse.
  23. </member>
  24. <member name="speed" type="Vector2" setter="set_speed" getter="get_speed" default="Vector2( 0, 0 )">
  25. The mouse speed in pixels per second.
  26. </member>
  27. <member name="tilt" type="Vector2" setter="set_tilt" getter="get_tilt" default="Vector2( 0, 0 )">
  28. Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from [code]-1.0[/code] to [code]1.0[/code] for both axes.
  29. </member>
  30. </members>
  31. <constants>
  32. </constants>
  33. </class>