ContextActionService
CreatorHub

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service]

Member index 30

History		Member
573		BindAction(actionName: string, functionToBind: Function, createTouchButton: bool, inputTypes: Tuple): null
573		BindActionAtPriority(actionName: string, functionToBind: Function, createTouchButton: bool, priorityLevel: int, inputTypes: Tuple): null
573		BindActionToInputTypes(actionName: string, functionToBind: Function, createTouchButton: bool, inputTypes: Tuple): null
573		BindActivate(userInputTypeForActivation: UserInputType, keyCodesForActivation: Tuple): null
573		BindCoreAction(actionName: string, functionToBind: Function, createTouchButton: bool, inputTypes: Tuple): null
573		BindCoreActionAtPriority(actionName: string, functionToBind: Function, createTouchButton: bool, priorityLevel: int, inputTypes: Tuple): null
573		BindCoreActivate(userInputTypeForActivation: UserInputType, keyCodesForActivation: Tuple): null
462		CallFunction(actionName: string, state: UserInputState, inputObject: Instance): Tuple
573		FireActionButtonFoundSignal(actionName: string, actionButton: Instance): null
462		GetAllBoundActionInfo(): Dictionary
462		GetAllBoundCoreActionInfo(): Dictionary
462		GetBoundActionInfo(actionName: string): Dictionary
462		GetBoundCoreActionInfo(actionName: string): Dictionary
462		GetButton(actionName: string): Instance
462		GetCurrentLocalToolIcon(): string
573		SetDescription(actionName: string, description: string): null
573		SetImage(actionName: string, image: string): null
573		SetPosition(actionName: string, position: UDim2): null
573		SetTitle(actionName: string, title: string): null
573		UnbindAction(actionName: string): null
573		UnbindActivate(userInputTypeForActivation: UserInputType, keyCodeForActivation: KeyCode = Unknown): null
573		UnbindAllActions(): null
573		UnbindCoreAction(actionName: string): null
573		UnbindCoreActivate(userInputTypeForActivation: UserInputType, keyCodeForActivation: KeyCode = Unknown): null
462		BoundActionAdded(actionAdded: string, createTouchButton: bool, functionInfoTable: Dictionary, isCore: bool)
462		BoundActionChanged(actionChanged: string, changeName: string, changeTable: Dictionary)
462		BoundActionRemoved(actionRemoved: string, functionInfoTable: Dictionary, isCore: bool)
462		GetActionButtonEvent(actionName: string)
462		LocalToolEquipped(toolEquipped: Instance)
462		LocalToolUnequipped(toolUnequipped: Instance)
68 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		ClassName: string
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		className: string
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
486		GetChildren(): Objects
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
462		GetPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsA(className: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
553		children(): Objects
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
553		getChildren(): Objects
462		isA(className: string): bool
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		Changed(property: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)

Removed member index 3

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

History 92
Hide member changes

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
CreatorHub

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
CreatorHub

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
CreatorHub

Parameters (4)
actionName	string
functionToBind	Function
createTouchButton	bool
inputTypes	Tuple
Returns (1)
null

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

Tags: [Deprecated]

BindActivate
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

Parameters (1)
actionName	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetActionButtonEvent from to Unsafe
145 Add GetActionButtonEvent

GetAllBoundActionInfo
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Dictionary

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetAllBoundActionInfo from to Unsafe
145 Add GetAllBoundActionInfo

GetAllBoundCoreActionInfo
CreatorHub

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
CreatorHub

Parameters (1)
actionName	string
Returns (1)
Dictionary

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetBoundActionInfo from to Unsafe
145 Add GetBoundActionInfo

GetBoundCoreActionInfo
CreatorHub

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
CreatorHub

Parameters (1)
actionName	string
Returns (1)
Instance

It will block the calling thread until completion.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetButton from to Unsafe
145 Add GetButton

Tags: [Yields]

GetCurrentLocalToolIcon
CreatorHub

Parameters (0)
No parameters.
Returns (1)
string

Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetCurrentLocalToolIcon from to Unsafe
90 Add GetCurrentLocalToolIcon

LocalToolEquipped
CreatorHub

Parameters (1)
toolEquipped	Instance

Thread safety	Unsafe

History 2

462 Change ThreadSafety of LocalToolEquipped from to Unsafe
90 Add LocalToolEquipped

LocalToolUnequipped
CreatorHub

Parameters (1)
toolUnequipped	Instance

Thread safety	Unsafe

History 2

462 Change ThreadSafety of LocalToolUnequipped from to Unsafe
90 Add LocalToolUnequipped

SetDescription
CreatorHub

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
CreatorHub

Parameters (2)
actionName	string
image	string
Returns (1)
null

Thread safety	Unsafe

History 3

573 Change ReturnType of SetImage from void to null
462 Change ThreadSafety of SetImage from to Unsafe
145 Add SetImage

SetPosition
CreatorHub

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
CreatorHub

Parameters (2)
actionName	string
title	string
Returns (1)
null

Thread safety	Unsafe

History 3

573 Change ReturnType of SetTitle from void to null
462 Change ThreadSafety of SetTitle from to Unsafe
145 Add SetTitle

UnbindAction
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

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
CreatorHub

Parameters (0)
No parameters.
Returns (1)
void

Security	RobloxScriptSecurity

History 2

145 Remove ActivateLocalTool
90 Add ActivateLocalTool

ContextButtonEnabled
CreatorHub

Type		Default
bool

Category
Loaded/Saved	false

History 2

145 Remove ContextButtonEnabled
90 Add ContextButtonEnabled

DeactivateLocalTool
CreatorHub

Parameters (0)
No parameters.
Returns (1)
void

Security	RobloxScriptSecurity

History 2

145 Remove DeactivateLocalTool
90 Add DeactivateLocalTool

Engine API

Website

Related

History 5

History 3

History 7

History 4

History 3

History 3

History 2

History 3

History 2

History 3

History 3

History 3

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 3

History 3

History 3

History 3

History 3

History 3

History 3

History 3

History 2

History 2

History 2

History 2