Enum Control.MouseFilterEnum

Namespace

Godot

Assembly

GodotSharp.dll

public enum Control.MouseFilterEnum : long

Fields

Ignore = 2

The control will not receive any mouse movement input events nor mouse button input events through _GuiInput(InputEvent). The control will also not receive the MouseEntered nor MouseExited signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. If a child has Pass and an event was passed to this control, the event will further propagate up to the control's parent.

Note: If the control has received MouseEntered but not MouseExited, changing the MouseFilter to Ignore will cause MouseExited to be emitted.

Pass = 1

The control will receive mouse movement input events and mouse button input events if clicked on through _GuiInput(InputEvent). The control will also receive the MouseEntered and MouseExited signals.

If this control does not handle the event, the event will propagate up to its parent control if it has one. The event is bubbled up the node hierarchy until it reaches a non-CanvasItem, a control with Stop, or a CanvasItem with TopLevel enabled. This will allow signals to fire in all controls it reaches. If no control handled it, the event will be passed to _ShortcutInput(InputEvent) for further processing.

Stop = 0

The control will receive mouse movement input events and mouse button input events if clicked on through _GuiInput(InputEvent). The control will also receive the MouseEntered and MouseExited signals. These events are automatically marked as handled, and they will not propagate further to other controls. This also results in blocking signals in other controls.