BindActionAtPriority

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

BindActionAtPriority behaves like ContextActionService/BindAction|BindAction but also allows a priority to be assigned to the bound action. If multiple actions are bound to the same input, the higher priority function is called regardless of the order in which the actions were bound. In other words, this function overrides the normal “stack” behavior of BindAction.

Parameters

Name	Type	Default	Description
Name actionName	Type string	Default	Summary A string representing the action being performed (e.g. “HonkHorn” or “OpenDoor”)
Name functionToBind	Type Function	Default	Summary The action-handling function, called with the following parameters when the bound inputs are triggered: string (actionName), Enum.UserInputState and an InputObject
Name createTouchButton	Type bool	Default	Summary Whether a GUI button should be created for the action on touch input devices
Name priorityLevel	Type int	Default	Summary The priority level at which the action should be bound (higher considered before lower)
Name inputTypes	Type Tuple	Default	Summary Any number of Enum.KeyCode or Enum.UserInputType representing the inputs to bind to the action

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

ContextActionService BindAction Priorities

This code sample demonstrates how ContextActionService/BindActionAtPriority can be used to bind actions out of order yet still have the same priority levels. Normally, ContextActionService/BindAction|BindAction would operate on order (last bound action has highest priority), but priority levels override this. You can test this code by pasting it into a LocalScript in StarterPlayerScripts.

			
				ContextActionService BindAction Priorities

				Expected Output
			
				Expand
				
			local ContextActionService = game:GetService("ContextActionService")

local INPUT_KEY = Enum.KeyCode.Q
local INPUT_KEY2 = Enum.KeyCode.E

local function handleThrow() print("Throw") end
local function handePunch() print("Punch") end

-- Notice how Throw is bound at a higher priority than Punch (2>1)
-- Therefore, despite the order in which they were bound (Throw then Punch),
-- handleThrow will be called before handlePunch when INPUT_KEY (Q) is pressed.
ContextActionService:BindActionAtPriority("Throw", handleThrow, false, 2, INPUT_KEY)
ContextActionService:BindActionAtPriority("Punch", handePunch, false, 1, INPUT_KEY)
-- Here, we don't use a priority (BindAction) so order matters.
-- Since Punch2 is bound after Throw2, it takes priority for INPUT_KEY2 (E).
ContextActionService:BindAction("Throw2", handleThrow, false, INPUT_KEY2)
ContextActionService:BindAction("Punch2", handePunch, false, INPUT_KEY2)
		
			When you press Q, Throw is printed.
When you press E, Punch is printed.
		
				Copy Code
			
				Light Theme

BindActionAtPriority

Parameters

actionName

functionToBind

createTouchButton

priorityLevel

inputTypes

Returns

void

Code Samples

ContextActionService BindAction Priorities