virtualx-engine/doc/classes/InputEventMouse.xml
2018-02-24 18:59:38 +01:00

29 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0.1">
<brief_description>
Base input event type for mouse events.
</brief_description>
<description>
Stores general mouse events information.
</description>
<tutorials>
http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask">
Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@GlobalScope].
</member>
<member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position">
Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0.
</member>
<member name="position" type="Vector2" setter="set_position" getter="get_position">
Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] which is under the mouse.
</member>
</members>
<constants>
</constants>
</class>