1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

InputSink

Controls how a GuiObject or GuiButton absorbs pointer and activation input events relative to GUI elements layered beneath it. Use this enum with the GuiObject.InputSink property, which defaults to InputSink.None on GuiObject and InputSink.Activate on GuiButton.

Items

NameValueDescription
None0The element does not sink any input events; pointer and activation events pass through to elements beneath it.
Activate1The element sinks activation input (button presses and taps) but allows hover, MouseEnter, and MouseLeave events to pass through to elements beneath it.
All100The element sinks all input events, preventing them from reaching any GUI element beneath it.

None

The element does not sink any input events; pointer and activation events pass through to elements beneath it.

FieldValue
value0

Activate

The element sinks activation input (button presses and taps) but allows hover, MouseEnter, and MouseLeave events to pass through to elements beneath it.

FieldValue
value1

All

The element sinks all input events, preventing them from reaching any GUI element beneath it.

FieldValue
value100