PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

SetDescription

SetDescription will set the description of an action bound by ContextActionService/BindAction|BindAction. In a list of available actions, this would be text that describes the given action.

Although the name may suggest that this method is related to the family of functions that customize a touch button for actions that create them (ContextActionService/SetTitle|SetTitle, ContextActionService/SetImage|SetImage and ContextActionService/SetPosition|SetPosition), this method does not affect such a button. This method merely sets a text description of an action, and nothing more.

Parameters

Name Type Default Description

The name of the action originally passed to BindAction

A text description of the action, such as “Honk the car’s horn” or “Open the inventory”

Returns

Return Type Summary