summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventMouseButton.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/InputEventMouseButton.xml')
-rw-r--r--doc/classes/InputEventMouseButton.xml79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml
new file mode 100644
index 0000000000..63e31eb61c
--- /dev/null
+++ b/doc/classes/InputEventMouseButton.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Input event type for mouse button events.
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_button_index" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_factor">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_doubleclick" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_button_index">
+ <return type="void">
+ </return>
+ <argument index="0" name="button_index" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_doubleclick">
+ <return type="void">
+ </return>
+ <argument index="0" name="doubleclick" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_factor">
+ <return type="void">
+ </return>
+ <argument index="0" name="factor" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_pressed">
+ <return type="void">
+ </return>
+ <argument index="0" name="pressed" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
+ Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
+ </member>
+ <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
+ Whether the event is a double-click.
+ </member>
+ <member name="factor" type="float" setter="set_factor" getter="get_factor">
+ </member>
+ <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
+ Pressed state of the mouse button.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>