ContextActionService
This class is not creatable. Instances 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 |
---|
Member index 30
Removed member index 3
History | Member | |
---|---|---|
145 | ContextButtonEnabled: bool | |
145 | ActivateLocalTool(): void | |
145 | DeactivateLocalTool(): void |
History 92
- 573 Change ReturnType of UnbindCoreActivate from void to null
- 573 Change ReturnType of UnbindCoreAction from void to null
- 573 Change ReturnType of UnbindAllActions from void to null
- 573 Change ReturnType of UnbindActivate from void to null
- 573 Change ReturnType of UnbindAction from void to null
- 573 Change ReturnType of SetTitle from void to null
- 573 Change ReturnType of SetPosition from void to null
- 573 Change ReturnType of SetImage from void to null
- 573 Change ReturnType of SetDescription from void to null
- 573 Change ReturnType of FireActionButtonFoundSignal from void to null
- 573 Change ReturnType of BindCoreActivate from void to null
- 573 Change ReturnType of BindCoreActionAtPriority from void to null
- 573 Change ReturnType of BindCoreAction from void to null
- 573 Change ReturnType of BindActivate from void to null
- 573 Change ReturnType of BindActionToInputTypes from void to null
- 573 Change ReturnType of BindActionAtPriority from void to null
- 573 Change ReturnType of BindAction from void to null
- 567 Add UnbindCoreActivate
- 567 Add BindCoreActivate
- 553 Change PreferredDescriptor of BindActionToInputTypes from to BindAction
- 549 Change Parameters of BindActivate from (userInputTypeForActivation: UserInputType, keyCodeForActivation: KeyCode = Unknown) to (userInputTypeForActivation: UserInputType, keyCodesForActivation: Tuple)
- 462 Change ThreadSafety of LocalToolUnequipped from to Unsafe
- 462 Change ThreadSafety of LocalToolEquipped from to Unsafe
- 462 Change ThreadSafety of GetActionButtonEvent from to Unsafe
- 462 Change ThreadSafety of BoundActionRemoved from to Unsafe
- 462 Change ThreadSafety of BoundActionChanged from to Unsafe
- 462 Change ThreadSafety of BoundActionAdded from to Unsafe
- 462 Change ThreadSafety of UnbindCoreAction from to Unsafe
- 462 Change ThreadSafety of UnbindAllActions from to Unsafe
- 462 Change ThreadSafety of UnbindActivate from to Unsafe
- 462 Change ThreadSafety of UnbindAction from to Unsafe
- 462 Change ThreadSafety of SetTitle from to Unsafe
- 462 Change ThreadSafety of SetPosition from to Unsafe
- 462 Change ThreadSafety of SetImage from to Unsafe
- 462 Change ThreadSafety of SetDescription from to Unsafe
- 462 Change ThreadSafety of GetCurrentLocalToolIcon from to Unsafe
- 462 Change ThreadSafety of GetButton from to Unsafe
- 462 Change ThreadSafety of GetBoundCoreActionInfo from to Unsafe
- 462 Change ThreadSafety of GetBoundActionInfo from to Unsafe
- 462 Change ThreadSafety of GetAllBoundCoreActionInfo from to Unsafe
- 462 Change ThreadSafety of GetAllBoundActionInfo from to Unsafe
- 462 Change ThreadSafety of FireActionButtonFoundSignal from to Unsafe
- 462 Change ThreadSafety of CallFunction from to Unsafe
- 462 Change ThreadSafety of BindCoreActionAtPriority from to Unsafe
- 462 Change ThreadSafety of BindCoreAction from to Unsafe
- 462 Change ThreadSafety of BindActivate from to Unsafe
- 462 Change ThreadSafety of BindActionToInputTypes from to Unsafe
- 462 Change ThreadSafety of BindActionAtPriority from to Unsafe
- 462 Change ThreadSafety of BindAction from to Unsafe
- 313 Add BindCoreActionAtPriority
- 296 Change Parameters of BoundActionRemoved from (actionRemoved: string, functionInfoTable: Dictionary) to (actionRemoved: string, functionInfoTable: Dictionary, isCore: bool)
- 296 Change Parameters of BoundActionAdded from (actionAdded: string, createTouchButton: bool, functionInfoTable: Dictionary) to (actionAdded: string, createTouchButton: bool, functionInfoTable: Dictionary, isCore: bool)
- 296 Add GetBoundCoreActionInfo
- 296 Add GetAllBoundCoreActionInfo
- 295 Add BindActionAtPriority
- 294 Change ReturnType of CallFunction from void to Tuple
- 199 Add UnbindActivate
- 199 Add BindActivate
- 194 Add UnbindCoreAction
- 194 Add BindCoreAction
- 193 Change Tags of BindActionToInputTypes from [] to [Deprecated]
- 193 Add BindAction
- 192 Change Tags of BindActionToInputTypes from [Deprecated] to []
- 192 Remove BindAction
- 193 Change Tags of BindActionToInputTypes from [] to [Deprecated]
- 193 Add BindAction
- 145 Add GetActionButtonEvent
- 145 Add BoundActionRemoved
- 145 Add BoundActionChanged
- 145 Add BoundActionAdded
- 145 Add UnbindAllActions
- 145 Add UnbindAction
- 145 Add SetTitle
- 145 Add SetPosition
- 145 Add SetImage
- 145 Add SetDescription
- 145 Add GetButton
- 145 Add GetBoundActionInfo
- 145 Add GetAllBoundActionInfo
- 145 Add FireActionButtonFoundSignal
- 145 Remove DeactivateLocalTool
- 145 Add CallFunction
- 145 Add BindActionToInputTypes
- 145 Remove ActivateLocalTool
- 145 Remove ContextButtonEnabled
- 90 Add LocalToolUnequipped
- 90 Add LocalToolEquipped
- 90 Add GetCurrentLocalToolIcon
- 90 Add DeactivateLocalTool
- 90 Add ActivateLocalTool
- 90 Add ContextButtonEnabled
- 90 Add ContextActionService
Members 30
BindAction
Parameters (4) | ||
---|---|---|
actionName | string | |
functionToBind | Function | |
createTouchButton | bool | |
inputTypes | Tuple | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 5
- 573 Change ReturnType of BindAction from void to null
- 462 Change ThreadSafety of BindAction from to Unsafe
- 193 Add BindAction
- 192 Remove BindAction
- 193 Add BindAction
BindActionAtPriority
Parameters (5) | ||
---|---|---|
actionName | string | |
functionToBind | Function | |
createTouchButton | bool | |
priorityLevel | int | |
inputTypes | Tuple | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of BindActionAtPriority from void to null
- 462 Change ThreadSafety of BindActionAtPriority from to Unsafe
- 295 Add BindActionAtPriority
BindActionToInputTypes
Parameters (4) | ||
---|---|---|
actionName | string | |
functionToBind | Function | |
createTouchButton | bool | |
inputTypes | Tuple | |
Returns (1) | ||
null |
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. BindAction should be used instead.
Thread safety | Unsafe |
---|
History 7
- 573 Change ReturnType of BindActionToInputTypes from void to null
- 553 Change PreferredDescriptor of BindActionToInputTypes from to BindAction
- 462 Change ThreadSafety of BindActionToInputTypes from to Unsafe
- 193 Change Tags of BindActionToInputTypes from [] to [Deprecated]
- 192 Change Tags of BindActionToInputTypes from [Deprecated] to []
- 193 Change Tags of BindActionToInputTypes from [] to [Deprecated]
- 145 Add BindActionToInputTypes
BindActivate
Parameters (2) | ||
---|---|---|
userInputTypeForActivation | UserInputType | |
keyCodesForActivation | Tuple | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 4
- 573 Change ReturnType of BindActivate from void to null
- 549 Change Parameters of BindActivate from (userInputTypeForActivation: UserInputType, keyCodeForActivation: KeyCode = Unknown) to (userInputTypeForActivation: UserInputType, keyCodesForActivation: Tuple)
- 462 Change ThreadSafety of BindActivate from to Unsafe
- 199 Add BindActivate
BindCoreAction
Parameters (4) | ||
---|---|---|
actionName | string | |
functionToBind | Function | |
createTouchButton | bool | |
inputTypes | Tuple | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of BindCoreAction from void to null
- 462 Change ThreadSafety of BindCoreAction from to Unsafe
- 194 Add BindCoreAction
BindCoreActionAtPriority
Parameters (5) | ||
---|---|---|
actionName | string | |
functionToBind | Function | |
createTouchButton | bool | |
priorityLevel | int | |
inputTypes | Tuple | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of BindCoreActionAtPriority from void to null
- 462 Change ThreadSafety of BindCoreActionAtPriority from to Unsafe
- 313 Add BindCoreActionAtPriority
BindCoreActivate
Parameters (2) | ||
---|---|---|
userInputTypeForActivation | UserInputType | |
keyCodesForActivation | Tuple | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 573 Change ReturnType of BindCoreActivate from void to null
- 567 Add BindCoreActivate
BoundActionAdded
Parameters (4) | |
---|---|
actionAdded | string |
createTouchButton | bool |
functionInfoTable | Dictionary |
isCore | bool |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of BoundActionAdded from to Unsafe
- 296 Change Parameters of BoundActionAdded from (actionAdded: string, createTouchButton: bool, functionInfoTable: Dictionary) to (actionAdded: string, createTouchButton: bool, functionInfoTable: Dictionary, isCore: bool)
- 145 Add BoundActionAdded
BoundActionChanged
Parameters (3) | |
---|---|
actionChanged | string |
changeName | string |
changeTable | Dictionary |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of BoundActionChanged from to Unsafe
- 145 Add BoundActionChanged
BoundActionRemoved
Parameters (3) | |
---|---|
actionRemoved | string |
functionInfoTable | Dictionary |
isCore | bool |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of BoundActionRemoved from to Unsafe
- 296 Change Parameters of BoundActionRemoved from (actionRemoved: string, functionInfoTable: Dictionary) to (actionRemoved: string, functionInfoTable: Dictionary, isCore: bool)
- 145 Add BoundActionRemoved
CallFunction
Parameters (3) | ||
---|---|---|
actionName | string | |
state | UserInputState | |
inputObject | Instance | |
Returns (1) | ||
Tuple |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 462 Change ThreadSafety of CallFunction from to Unsafe
- 294 Change ReturnType of CallFunction from void to Tuple
- 145 Add CallFunction
FireActionButtonFoundSignal
Parameters (2) | ||
---|---|---|
actionName | string | |
actionButton | Instance | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of FireActionButtonFoundSignal from void to null
- 462 Change ThreadSafety of FireActionButtonFoundSignal from to Unsafe
- 145 Add FireActionButtonFoundSignal
GetActionButtonEvent
Parameters (1) | |
---|---|
actionName | string |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetActionButtonEvent from to Unsafe
- 145 Add GetActionButtonEvent
GetAllBoundActionInfo
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Dictionary |
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of GetAllBoundActionInfo from to Unsafe
- 145 Add GetAllBoundActionInfo
GetAllBoundCoreActionInfo
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Dictionary |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetAllBoundCoreActionInfo from to Unsafe
- 296 Add GetAllBoundCoreActionInfo
GetBoundActionInfo
Parameters (1) | ||
---|---|---|
actionName | string | |
Returns (1) | ||
Dictionary |
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of GetBoundActionInfo from to Unsafe
- 145 Add GetBoundActionInfo
GetBoundCoreActionInfo
Parameters (1) | ||
---|---|---|
actionName | string | |
Returns (1) | ||
Dictionary |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetBoundCoreActionInfo from to Unsafe
- 296 Add GetBoundCoreActionInfo
GetButton
Parameters (1) | ||
---|---|---|
actionName | string | |
Returns (1) | ||
Instance |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
GetCurrentLocalToolIcon
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
string |
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of GetCurrentLocalToolIcon from to Unsafe
- 90 Add GetCurrentLocalToolIcon
LocalToolEquipped
Parameters (1) | |
---|---|
toolEquipped | Instance |
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of LocalToolEquipped from to Unsafe
- 90 Add LocalToolEquipped
LocalToolUnequipped
Parameters (1) | |
---|---|
toolUnequipped | Instance |
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of LocalToolUnequipped from to Unsafe
- 90 Add LocalToolUnequipped
SetDescription
Parameters (2) | ||
---|---|---|
actionName | string | |
description | string | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of SetDescription from void to null
- 462 Change ThreadSafety of SetDescription from to Unsafe
- 145 Add SetDescription
SetImage
Parameters (2) | ||
---|---|---|
actionName | string | |
image | string | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
SetPosition
Parameters (2) | ||
---|---|---|
actionName | string | |
position | UDim2 | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of SetPosition from void to null
- 462 Change ThreadSafety of SetPosition from to Unsafe
- 145 Add SetPosition
SetTitle
Parameters (2) | ||
---|---|---|
actionName | string | |
title | string | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
UnbindAction
Parameters (1) | ||
---|---|---|
actionName | string | |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of UnbindAction from void to null
- 462 Change ThreadSafety of UnbindAction from to Unsafe
- 145 Add UnbindAction
UnbindActivate
Parameters (2) | Default | |
---|---|---|
userInputTypeForActivation | UserInputType | |
keyCodeForActivation | KeyCode | Unknown |
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of UnbindActivate from void to null
- 462 Change ThreadSafety of UnbindActivate from to Unsafe
- 199 Add UnbindActivate
UnbindAllActions
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
null |
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of UnbindAllActions from void to null
- 462 Change ThreadSafety of UnbindAllActions from to Unsafe
- 145 Add UnbindAllActions
UnbindCoreAction
Parameters (1) | ||
---|---|---|
actionName | string | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of UnbindCoreAction from void to null
- 462 Change ThreadSafety of UnbindCoreAction from to Unsafe
- 194 Add UnbindCoreAction
UnbindCoreActivate
Parameters (2) | Default | |
---|---|---|
userInputTypeForActivation | UserInputType | |
keyCodeForActivation | KeyCode | Unknown |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 573 Change ReturnType of UnbindCoreActivate from void to null
- 567 Add UnbindCoreActivate
Removed members 3
ActivateLocalTool
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
void |
Security | RobloxScriptSecurity |
---|
History 2
- 145 Remove ActivateLocalTool
- 90 Add ActivateLocalTool
ContextButtonEnabled
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 145 Remove ContextButtonEnabled
- 90 Add ContextButtonEnabled
DeactivateLocalTool
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
void |
Security | RobloxScriptSecurity |
---|
History 2
- 145 Remove DeactivateLocalTool
- 90 Add DeactivateLocalTool