mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-24 15:01:38 +00:00
36 lines
1.4 KiB
YAML
36 lines
1.4 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: ContextActionResult
|
|
type: enum
|
|
summary: |
|
|
Describes whether a contextual action should sink or pass input events.
|
|
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.
|
|
code_samples: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
items:
|
|
- name: Sink
|
|
summary: |
|
|
If `functionToBind` from `Class.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.
|
|
value: 0
|
|
tags: []
|
|
deprecation_message: ''
|
|
- name: Pass
|
|
summary: |
|
|
If `functionToBind` from `Class.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.
|
|
value: 1
|
|
tags: []
|
|
deprecation_message: ''
|