Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ContextActionService

Summary

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.
Tags: [NotCreatable, Service]

Member index 30

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

Removed member index 3

HistoryMember
145ContextButtonEnabled: bool
145ActivateLocalTool(): void
145DeactivateLocalTool(): void

History 92

Members 30

BindAction

Parameters (4)
actionNamestring
functionToBindFunction
createTouchButtonbool
inputTypesTuple
Returns (1)
null

History 5

BindActionAtPriority

Parameters (5)
actionNamestring
functionToBindFunction
createTouchButtonbool
priorityLevelint
inputTypesTuple
Returns (1)
null

History 3

BindActionToInputTypes

Parameters (4)
actionNamestring
functionToBindFunction
createTouchButtonbool
inputTypesTuple
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.

History 7

Tags: [Deprecated]

BindActivate

Parameters (2)
userInputTypeForActivationUserInputType
keyCodesForActivationTuple
Returns (1)
null

History 4

BindCoreAction

Parameters (4)
actionNamestring
functionToBindFunction
createTouchButtonbool
inputTypesTuple
Returns (1)
null

History 3

BindCoreActionAtPriority

Parameters (5)
actionNamestring
functionToBindFunction
createTouchButtonbool
priorityLevelint
inputTypesTuple
Returns (1)
null

History 3

BindCoreActivate

Parameters (2)
userInputTypeForActivationUserInputType
keyCodesForActivationTuple
Returns (1)
null

History 2

BoundActionAdded

Parameters (4)
actionAddedstring
createTouchButtonbool
functionInfoTableDictionary
isCorebool

History 3

BoundActionChanged

Parameters (3)
actionChangedstring
changeNamestring
changeTableDictionary

History 2

BoundActionRemoved

Parameters (3)
actionRemovedstring
functionInfoTableDictionary
isCorebool

History 3

CallFunction

Parameters (3)
actionNamestring
stateUserInputState
inputObjectInstance
Returns (1)
Tuple

History 3

FireActionButtonFoundSignal

Parameters (2)
actionNamestring
actionButtonInstance
Returns (1)
null

History 3

GetActionButtonEvent

Parameters (1)
actionNamestring

History 2

GetAllBoundActionInfo

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

History 2

GetAllBoundCoreActionInfo

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

History 2

GetBoundActionInfo

Parameters (1)
actionNamestring
Returns (1)
Dictionary

History 2

GetBoundCoreActionInfo

Parameters (1)
actionNamestring
Returns (1)
Dictionary

History 2

GetButton

Parameters (1)
actionNamestring
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetCurrentLocalToolIcon

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

History 2

LocalToolEquipped

Parameters (1)
toolEquippedInstance

History 2

LocalToolUnequipped

Parameters (1)
toolUnequippedInstance

History 2

SetDescription

Parameters (2)
actionNamestring
descriptionstring
Returns (1)
null

History 3

SetImage

Parameters (2)
actionNamestring
imagestring
Returns (1)
null

History 3

SetPosition

Parameters (2)
actionNamestring
positionUDim2
Returns (1)
null

History 3

SetTitle

Parameters (2)
actionNamestring
titlestring
Returns (1)
null

History 3

UnbindAction

Parameters (1)
actionNamestring
Returns (1)
null

History 3

UnbindActivate

Parameters (2)Default
userInputTypeForActivationUserInputType
keyCodeForActivationKeyCodeUnknown
Returns (1)
null

History 3

UnbindAllActions

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

History 3

UnbindCoreAction

Parameters (1)
actionNamestring
Returns (1)
null

History 3

UnbindCoreActivate

Parameters (2)Default
userInputTypeForActivationUserInputType
keyCodeForActivationKeyCodeUnknown
Returns (1)
null

History 2

Removed members 3

ActivateLocalTool

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

History 2

ContextButtonEnabled

TypeDefault
bool

History 2

DeactivateLocalTool

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

History 2

Settings