PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. apireference
  2. input
  3. contextactionservice

GetBoundActionInfo

ContextActionService

GetBoundActionInfo returns a table with the following keys describing a bound action given its name. To get the same information for all actions at once, use ContextActionService/GetAllBoundActionInfo|GetAllBoundActionInfo.

NameTypeDescription
stackOrdernumber

Describes the index of the action on the stack (increasing)

priorityLevel*number

Describes the ContextActionService/BindActionAtPriority|priority level of the action

createTouchButtonbool

Describes whether a touch button should be created on UserInputService/TouchEnabled|TouchEnabled devices

inputTypestable

The input types passed to ContextActionService/BindAction|BindAction for which this action will trigger

description†string

The description of action set by ContextActionService/SetDescription|SetDescription

title†string

The title of the action set by ContextActionService/SetTitle|SetTitle

image†string

The image of the action’s touch button set by ContextActionService/SetImage|SetImage

*Priority level will still be included even if ContextActionService/BindActionAtPriority|BindActionAtPriority wasn’t used - by default it will be 2000.
†Indicates that this field will be nil if the associated method was not called for the given action.

Parameters

Name Type Default Description

actionName

string

Returns

Return Type Summary

Dictionary