ContextActionService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

Memory Category	Instances

Tags: [NotCreatable, Service]

Inherits (1)

Instance

Member index (30)

Type	Member	History
null	BindAction (string actionName, Function functionToBind, bool createTouchButton, Tuple inputTypes)	193 192 193 573
null	BindActionAtPriority (string actionName, Function functionToBind, bool createTouchButton, int priorityLevel, Tuple inputTypes)	295 573
null	BindActionToInputTypes (string actionName, Function functionToBind, bool createTouchButton, Tuple inputTypes)	145 193 192 193 573
null	BindActivate (UserInputType userInputTypeForActivation, Tuple keyCodesForActivation)	199 549 573
null	BindCoreAction (string actionName, Function functionToBind, bool createTouchButton, Tuple inputTypes)	194 573
null	BindCoreActionAtPriority (string actionName, Function functionToBind, bool createTouchButton, int priorityLevel, Tuple inputTypes)	313 573
null	BindCoreActivate (UserInputType userInputTypeForActivation, Tuple keyCodesForActivation)	567 573
Tuple	CallFunction (string actionName, UserInputState state, Instance inputObject)	145 294
null	FireActionButtonFoundSignal (string actionName, Instance actionButton)	145 573
Dictionary	GetAllBoundActionInfo ()	145
Dictionary	GetAllBoundCoreActionInfo ()	296
Dictionary	GetBoundActionInfo (string actionName)	145
Dictionary	GetBoundCoreActionInfo (string actionName)	296
Instance	GetButton (string actionName)	145
string	GetCurrentLocalToolIcon ()
null	SetDescription (string actionName, string description)	145 573
null	SetImage (string actionName, string image)	145 573
null	SetPosition (string actionName, UDim2 position)	145 573
null	SetTitle (string actionName, string title)	145 573
null	UnbindAction (string actionName)	145 573
null	UnbindActivate (UserInputType userInputTypeForActivation, KeyCode keyCodeForActivation = Unknown)	199 573
null	UnbindAllActions ()	145 573
null	UnbindCoreAction (string actionName)	194 573
null	UnbindCoreActivate (UserInputType userInputTypeForActivation, KeyCode keyCodeForActivation = Unknown)	567 573
	BoundActionAdded (string actionAdded, bool createTouchButton, Dictionary functionInfoTable, bool isCore)	145 296
	BoundActionChanged (string actionChanged, string changeName, Dictionary changeTable)	145
	BoundActionRemoved (string actionRemoved, Dictionary functionInfoTable, bool isCore)	145 296
	GetActionButtonEvent (string actionName)	145
	LocalToolEquipped (Instance toolEquipped)
	LocalToolUnequipped (Instance toolUnequipped)
57 members inherited from Instance

Removed member index (3)

Type	Member	History
bool	ContextButtonEnabled	145
void	ActivateLocalTool ()	145
void	DeactivateLocalTool ()	145

573 Change ReturnType of ContextActionService.BindAction from void to null
573 Change ReturnType of ContextActionService.BindActionAtPriority from void to null
573 Change ReturnType of ContextActionService.BindActionToInputTypes from void to null
573 Change ReturnType of ContextActionService.BindActivate from void to null
573 Change ReturnType of ContextActionService.BindCoreAction from void to null
573 Change ReturnType of ContextActionService.BindCoreActionAtPriority from void to null
573 Change ReturnType of ContextActionService.BindCoreActivate from void to null
573 Change ReturnType of ContextActionService.FireActionButtonFoundSignal from void to null
573 Change ReturnType of ContextActionService.SetDescription from void to null
573 Change ReturnType of ContextActionService.SetImage from void to null
573 Change ReturnType of ContextActionService.SetPosition from void to null
573 Change ReturnType of ContextActionService.SetTitle from void to null
573 Change ReturnType of ContextActionService.UnbindAction from void to null
573 Change ReturnType of ContextActionService.UnbindActivate from void to null
573 Change ReturnType of ContextActionService.UnbindAllActions from void to null
573 Change ReturnType of ContextActionService.UnbindCoreAction from void to null
573 Change ReturnType of ContextActionService.UnbindCoreActivate from void to null
567 Add ContextActionService.BindCoreActivate
567 Add ContextActionService.UnbindCoreActivate
549 Change Parameters of ContextActionService.BindActivate from (UserInputType userInputTypeForActivation, KeyCode keyCodeForActivation = Unknown) to (UserInputType userInputTypeForActivation, Tuple keyCodesForActivation)
313 Add ContextActionService.BindCoreActionAtPriority
296 Add ContextActionService.GetAllBoundCoreActionInfo
296 Add ContextActionService.GetBoundCoreActionInfo
296 Change Parameters of ContextActionService.BoundActionAdded from (string actionAdded, bool createTouchButton, Dictionary functionInfoTable) to (string actionAdded, bool createTouchButton, Dictionary functionInfoTable, bool isCore)
296 Change Parameters of ContextActionService.BoundActionRemoved from (string actionRemoved, Dictionary functionInfoTable) to (string actionRemoved, Dictionary functionInfoTable, bool isCore)
295 Add ContextActionService.BindActionAtPriority
294 Change ReturnType of ContextActionService.CallFunction from void to Tuple
199 Add ContextActionService.BindActivate
199 Add ContextActionService.UnbindActivate
194 Add ContextActionService.BindCoreAction
194 Add ContextActionService.UnbindCoreAction
193 Add ContextActionService.BindAction
193 Change Tags of ContextActionService.BindActionToInputTypes from [] to [Deprecated]
192 Remove ContextActionService.BindAction
192 Change Tags of ContextActionService.BindActionToInputTypes from [Deprecated] to []
193 Add ContextActionService.BindAction
193 Change Tags of ContextActionService.BindActionToInputTypes from [] to [Deprecated]
145 Remove ContextActionService.ContextButtonEnabled
145 Remove ContextActionService.ActivateLocalTool
145 Add ContextActionService.BindActionToInputTypes
145 Add ContextActionService.CallFunction
145 Remove ContextActionService.DeactivateLocalTool
145 Add ContextActionService.FireActionButtonFoundSignal
145 Add ContextActionService.GetAllBoundActionInfo
145 Add ContextActionService.GetBoundActionInfo
145 Add ContextActionService.GetButton
145 Add ContextActionService.SetDescription
145 Add ContextActionService.SetImage
145 Add ContextActionService.SetPosition
145 Add ContextActionService.SetTitle
145 Add ContextActionService.UnbindAction
145 Add ContextActionService.UnbindAllActions
145 Add ContextActionService.BoundActionAdded
145 Add ContextActionService.BoundActionChanged
145 Add ContextActionService.BoundActionRemoved
145 Add ContextActionService.GetActionButtonEvent
90 Add ContextActionService

Members

BindAction On DevHub

Parameters	4

Name	Type	Default
actionName	string	none
functionToBind	Function	none
createTouchButton	bool	none
inputTypes	Tuple	none

Return Type	null

History

573 Change ReturnType of ContextActionService.BindAction from void to null
193 Add ContextActionService.BindAction
192 Remove ContextActionService.BindAction
193 Add ContextActionService.BindAction

BindActionAtPriority On DevHub

Parameters	5

Name	Type	Default
actionName	string	none
functionToBind	Function	none
createTouchButton	bool	none
priorityLevel	int	none
inputTypes	Tuple	none

Return Type	null

History

573 Change ReturnType of ContextActionService.BindActionAtPriority from void to null
295 Add ContextActionService.BindActionAtPriority

BindActionToInputTypes On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	4

Name	Type	Default
actionName	string	none
functionToBind	Function	none
createTouchButton	bool	none
inputTypes	Tuple	none

Return Type	null

History

573 Change ReturnType of ContextActionService.BindActionToInputTypes from void to null
193 Change Tags of ContextActionService.BindActionToInputTypes from [] to [Deprecated]
192 Change Tags of ContextActionService.BindActionToInputTypes from [Deprecated] to []
193 Change Tags of ContextActionService.BindActionToInputTypes from [] to [Deprecated]
145 Add ContextActionService.BindActionToInputTypes

Tags: [Deprecated]

BindActivate On DevHub

Parameters	2

Name	Type	Default
userInputTypeForActivation	UserInputType	none
keyCodesForActivation	Tuple	none

Return Type	null

History

573 Change ReturnType of ContextActionService.BindActivate from void to null
549 Change Parameters of ContextActionService.BindActivate from (UserInputType userInputTypeForActivation, KeyCode keyCodeForActivation = Unknown) to (UserInputType userInputTypeForActivation, Tuple keyCodesForActivation)
199 Add ContextActionService.BindActivate

BindCoreAction On DevHub

Parameters	4

Name	Type	Default
actionName	string	none
functionToBind	Function	none
createTouchButton	bool	none
inputTypes	Tuple	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ContextActionService.BindCoreAction from void to null
194 Add ContextActionService.BindCoreAction

BindCoreActionAtPriority On DevHub

Parameters	5

Name	Type	Default
actionName	string	none
functionToBind	Function	none
createTouchButton	bool	none
priorityLevel	int	none
inputTypes	Tuple	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ContextActionService.BindCoreActionAtPriority from void to null
313 Add ContextActionService.BindCoreActionAtPriority

BindCoreActivate On DevHub

Parameters	2

Name	Type	Default
userInputTypeForActivation	UserInputType	none
keyCodesForActivation	Tuple	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ContextActionService.BindCoreActivate from void to null
567 Add ContextActionService.BindCoreActivate

BoundActionAdded On DevHub

Parameters	4

Name	Type	Default
actionAdded	string	none
createTouchButton	bool	none
functionInfoTable	Dictionary	none
isCore	bool	none

Security	RobloxScriptSecurity

History

296 Change Parameters of ContextActionService.BoundActionAdded from (string actionAdded, bool createTouchButton, Dictionary functionInfoTable) to (string actionAdded, bool createTouchButton, Dictionary functionInfoTable, bool isCore)
145 Add ContextActionService.BoundActionAdded

BoundActionChanged On DevHub

Parameters	3

Name	Type	Default
actionChanged	string	none
changeName	string	none
changeTable	Dictionary	none

Security	RobloxScriptSecurity

History

145 Add ContextActionService.BoundActionChanged

BoundActionRemoved On DevHub

Parameters	3

Name	Type	Default
actionRemoved	string	none
functionInfoTable	Dictionary	none
isCore	bool	none

Security	RobloxScriptSecurity

History

296 Change Parameters of ContextActionService.BoundActionRemoved from (string actionRemoved, Dictionary functionInfoTable) to (string actionRemoved, Dictionary functionInfoTable, bool isCore)
145 Add ContextActionService.BoundActionRemoved

CallFunction On DevHub

Parameters	3

Name	Type	Default
actionName	string	none
state	UserInputState	none
inputObject	Instance	none

Return Type	Tuple
Security	RobloxScriptSecurity

History

294 Change ReturnType of ContextActionService.CallFunction from void to Tuple
145 Add ContextActionService.CallFunction

FireActionButtonFoundSignal On DevHub

Parameters	2

Name	Type	Default
actionName	string	none
actionButton	Instance	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ContextActionService.FireActionButtonFoundSignal from void to null
145 Add ContextActionService.FireActionButtonFoundSignal

GetActionButtonEvent On DevHub

Parameters	1

Name	Type	Default
actionName	string	none

Security	RobloxScriptSecurity

History

145 Add ContextActionService.GetActionButtonEvent

GetAllBoundActionInfo On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary

History

145 Add ContextActionService.GetAllBoundActionInfo

GetAllBoundCoreActionInfo On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Dictionary
Security	RobloxScriptSecurity

History

296 Add ContextActionService.GetAllBoundCoreActionInfo

GetBoundActionInfo On DevHub

Parameters	1

Name	Type	Default
actionName	string	none

Return Type	Dictionary

History

145 Add ContextActionService.GetBoundActionInfo

GetBoundCoreActionInfo On DevHub

Parameters	1

Name	Type	Default
actionName	string	none

Return Type	Dictionary
Security	RobloxScriptSecurity

History

296 Add ContextActionService.GetBoundCoreActionInfo

GetButton On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
actionName	string	none

Return Type	Instance

History

145 Add ContextActionService.GetButton

Tags: [Yields]

GetCurrentLocalToolIcon On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string

LocalToolEquipped On DevHub

Parameters	1

Name	Type	Default
toolEquipped	Instance	none

LocalToolUnequipped On DevHub

Parameters	1

Name	Type	Default
toolUnequipped	Instance	none

SetDescription On DevHub

Parameters	2

Name	Type	Default
actionName	string	none
description	string	none

Return Type	null

History

573 Change ReturnType of ContextActionService.SetDescription from void to null
145 Add ContextActionService.SetDescription

SetImage On DevHub

Parameters	2

Name	Type	Default
actionName	string	none
image	string	none

Return Type	null

History

573 Change ReturnType of ContextActionService.SetImage from void to null
145 Add ContextActionService.SetImage

SetPosition On DevHub

Parameters	2

Name	Type	Default
actionName	string	none
position	UDim2	none

Return Type	null

History

573 Change ReturnType of ContextActionService.SetPosition from void to null
145 Add ContextActionService.SetPosition

SetTitle On DevHub

Parameters	2

Name	Type	Default
actionName	string	none
title	string	none

Return Type	null

History

573 Change ReturnType of ContextActionService.SetTitle from void to null
145 Add ContextActionService.SetTitle

UnbindAction On DevHub

Parameters	1

Name	Type	Default
actionName	string	none

Return Type	null

History

573 Change ReturnType of ContextActionService.UnbindAction from void to null
145 Add ContextActionService.UnbindAction

UnbindActivate On DevHub

Parameters	2

Name	Type	Default
userInputTypeForActivation	UserInputType	none
keyCodeForActivation	KeyCode	Unknown

Return Type	null

History

573 Change ReturnType of ContextActionService.UnbindActivate from void to null
199 Add ContextActionService.UnbindActivate

UnbindAllActions On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of ContextActionService.UnbindAllActions from void to null
145 Add ContextActionService.UnbindAllActions

UnbindCoreAction On DevHub

Parameters	1

Name	Type	Default
actionName	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ContextActionService.UnbindCoreAction from void to null
194 Add ContextActionService.UnbindCoreAction

UnbindCoreActivate On DevHub

Parameters	2

Name	Type	Default
userInputTypeForActivation	UserInputType	none
keyCodeForActivation	KeyCode	Unknown

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ContextActionService.UnbindCoreActivate from void to null
567 Add ContextActionService.UnbindCoreActivate

Removed members

ActivateLocalTool

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

145 Remove ContextActionService.ActivateLocalTool

ContextButtonEnabled

Value Type	bool
Category
Can Load	false
Can Save	false

History

145 Remove ContextActionService.ContextButtonEnabled

DeactivateLocalTool

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity