summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventMouse.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/InputEventMouse.xml')
-rw-r--r--doc/classes/InputEventMouse.xml69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml
new file mode 100644
index 0000000000..15412b15e0
--- /dev/null
+++ b/doc/classes/InputEventMouse.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Base input event type for mouse events.
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_button_mask" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_global_position" qualifiers="const">
+ <return type="Vector2">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_position" qualifiers="const">
+ <return type="Vector2">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_button_mask">
+ <return type="void">
+ </return>
+ <argument index="0" name="button_mask" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_global_position">
+ <return type="void">
+ </return>
+ <argument index="0" name="global_position" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_position">
+ <return type="void">
+ </return>
+ <argument index="0" name="position" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" brief="">
+ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
+ </member>
+ <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" brief="">
+ Global position of the mouse click.
+ </member>
+ <member name="position" type="Vector2" setter="set_position" getter="get_position" brief="">
+ Local position of the mouse click.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>