From 305ab94431dd0569862b0c4f9820d591d0774393 Mon Sep 17 00:00:00 2001 From: PJB3005 Date: Thu, 4 Jan 2018 18:18:43 +0100 Subject: [PATCH] Document Control.mouse_filter and its constants. --- doc/classes/Control.xml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 6c30a92ed5f..680e008ff1d 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -632,6 +632,7 @@ Distance between the node's top edge and its parent container, based on [member anchor_top]. + Controls whether the control will be able to receive mouse button input events through [Control._gui_input] and how these events should be handled. Use one of the [code]MOUSE_FILTER_*[/code] constants. See the constants to learn what each does. @@ -869,10 +870,13 @@ Tells the parent [Container] to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. + The control will receive mouse button input events through [method Control._gui_input] if clicked on. These events are automatically marked as handled and they will not propogate further to other controls. + The control will receive mouse button input events through [method Control._gui_input] if clicked on. If this control does not handle the event, the parent control (if any) will be considered for a mouse click, and so on until there is no more parent control to potentially handle it. Even if no control handled it at all, the event will still be handled automatically. + The control will not receive mouse button input events through [method Control._gui_input] and will not block other controls from receiving these events. These events will also not be handled automatically.