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.


Pass

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.


Sink

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 . This is the default behavior
if _functionToBind_ does not return anything or yields in any way.


ContextActionResult

Describes whether a ContextAction should sink or pass input events.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

Unable to add to inventory

The code sample {title} has been added to your Inventory.

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

Name	Value	Summary
Pass	1
Sink	0

ContextActionResult

Items