PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference

ContextActionResult

Hide content
  1. API Reference
  2. Enum Index

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.


Enums

Name Value Description

Pass

 1

If functionToBind from /ContextActionService/BindAction returns Enum.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

 0

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