What does the Stop Mouse property do on a Control?

Archive
1
:information_source: Attention Topic was automatically imported from the old Question2Answer platform.
:bust_in_silhouette: Asked By duke_meister
:warning: Old Version Published before Godot 3 was released.

Ignore Mouse seems logical but what is Stop Mouse? It seems to be undocumented. Thanks.

4
:bust_in_silhouette: Reply From: lukas

Mouse event is “absorbed” by the control and it doesn’t “continue” to its parent node. It means that parent controls under the control with Stop Mouse will not receive mouse events.

EDITED according to volzhs’s comment.

Thanks for the answer, but isn’t this the way it works by default? (edit: changed my example. ) I just tried a test with 2 overlapping buttons (both with Stop Mouse turned off) sitting on top of a TextureFrame. If I move the mouse over them, only the topmost control will get it’s input_event() function called. I’ve also connected their ‘pressed’ signal and only the topmost button gets this called as well.

duke_meister | 2016-04-06 08:09

AFAIK, the event goes up to parent control node, not sibling node.
if stop mouse enabled, parent control will not receive mouse event.

volzhs | 2016-04-06 12:03