InputEventMouseButton.xml 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Input event type for mouse button events.
  5. </brief_description>
  6. <description>
  7. </description>
  8. <tutorials>
  9. </tutorials>
  10. <demos>
  11. </demos>
  12. <methods>
  13. <method name="get_button_index" qualifiers="const">
  14. <return type="int">
  15. </return>
  16. <description>
  17. </description>
  18. </method>
  19. <method name="get_factor">
  20. <return type="float">
  21. </return>
  22. <description>
  23. </description>
  24. </method>
  25. <method name="is_doubleclick" qualifiers="const">
  26. <return type="bool">
  27. </return>
  28. <description>
  29. </description>
  30. </method>
  31. <method name="set_button_index">
  32. <return type="void">
  33. </return>
  34. <argument index="0" name="button_index" type="int">
  35. </argument>
  36. <description>
  37. </description>
  38. </method>
  39. <method name="set_doubleclick">
  40. <return type="void">
  41. </return>
  42. <argument index="0" name="doubleclick" type="bool">
  43. </argument>
  44. <description>
  45. </description>
  46. </method>
  47. <method name="set_factor">
  48. <return type="void">
  49. </return>
  50. <argument index="0" name="factor" type="float">
  51. </argument>
  52. <description>
  53. </description>
  54. </method>
  55. <method name="set_pressed">
  56. <return type="void">
  57. </return>
  58. <argument index="0" name="pressed" type="bool">
  59. </argument>
  60. <description>
  61. </description>
  62. </method>
  63. </methods>
  64. <members>
  65. <member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
  66. Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
  67. </member>
  68. <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
  69. Whether the event is a double-click.
  70. </member>
  71. <member name="factor" type="float" setter="set_factor" getter="get_factor">
  72. </member>
  73. <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
  74. Pressed state of the mouse button.
  75. </member>
  76. </members>
  77. <constants>
  78. </constants>
  79. </class>