ContextActionResult
Describes whether a ContextAction should sink or pass input events.
Items 2
| History | Name | Value | Description | |
|---|---|---|---|---|
| 598 | 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 processed. This is the default behavior if functionToBind does not return anything or yields in any way. | |
| 598 | 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. |
Description
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.