2 min read

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

ContextActionResult

ContextActionResult controls the behavior of multiple bound actions. It gives the option of controlling whether or not a bound action should sink or pass the input event, meaning other things (including other bound actions) can process it.

Items

NameValueDescription
Sink0If functionToBind from ContextActionService:BindAction() returns ContextActionResult.Sink, the input event will stop at that function and no other bound actions under it will be processed. This is the default behavior if functionToBind does not return anything or yields in any way.
Pass1If functionToBind from ContextActionService:BindAction() returns ContextActionResult.Pass, the input event is considered to have not been handled by functionToBind and will continue being passed to actions bound to the same input type.

Sink

If functionToBind from ContextActionService:BindAction() returns ContextActionResult.Sink, the input event will stop at that function and no other bound actions under it will be processed. This is the default behavior if functionToBind does not return anything or yields in any way.

FieldValue
value0

Pass

If functionToBind from ContextActionService:BindAction() returns ContextActionResult.Pass, the input event is considered to have not been handled by functionToBind and will continue being passed to actions bound to the same input type.

FieldValue
value1