InputEventMouseButton.xml 1.4 KB

123456789101112131415161718192021222324252627282930
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.1.2">
  3. <brief_description>
  4. Input event type for mouse button events.
  5. </brief_description>
  6. <description>
  7. Contains mouse click information. See [method Node._input].
  8. </description>
  9. <tutorials>
  10. <link>https://docs.godotengine.org/en/3.1/tutorials/inputs/mouse_and_input_coordinates.html</link>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
  16. Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@GlobalScope].
  17. </member>
  18. <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
  19. If [code]true[/code], the mouse button's state is a double-click.
  20. </member>
  21. <member name="factor" type="float" setter="set_factor" getter="get_factor">
  22. Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported.
  23. </member>
  24. <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
  25. If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released.
  26. </member>
  27. </members>
  28. <constants>
  29. </constants>
  30. </class>