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.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml
index 99e25d2c6f..4cf7174ab1 100644
--- a/doc/classes/InputEventMouseButton.xml
+++ b/doc/classes/InputEventMouseButton.xml
@@ -12,16 +12,16 @@
<methods>
</methods>
<members>
- <member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
- Mouse button identifier, one of the [enum ButtonList] button or button wheel constants.
+ <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" default="0">
+ The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.
</member>
- <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
+ <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick" default="false">
If [code]true[/code], the mouse button's state is a double-click.
</member>
- <member name="factor" type="float" setter="set_factor" getter="get_factor">
- 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.
+ <member name="factor" type="float" setter="set_factor" getter="get_factor" default="1.0">
+ The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be [code]0[/code] if not supported.
</member>
- <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
+ <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released.
</member>
</members>