PluginAction

Show Deprecated
not replicated

PluginAction is an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Enum.Button. In Roblox Studio, they can be assigned a keyboard shortcut under File → Advanced → Customize Shortcuts..., and they can also be added to the Quick Access Toolbar.

PluginActions must be created using the Plugin:CreatePluginAction() function in order to work as expected.

Summary

Properties

  • read only
    not replicated
    read parallel

    A string that uniquely identifies this action.

  • read only
    not replicated
    read parallel

    Whether the PluginAction will be hidden from Studio's shortcuts view.

  • read only
    not replicated
    read parallel

    The description of the action, when viewing it from the keyboard shortcuts window in Roblox Studio.

  • read only
    not replicated
    read parallel

    The text that is displayed when viewing this action in Roblox Studio.

Events

  • Fires when the action is triggered. This can be done by either activating the action from the Quick Access Toolbar, or by using the keyboard shortcut that was bound to it.

Properties

ActionId

read only
not replicated
read parallel

A string that uniquely identifies this action. This string is the key used when saving and loading the action's state in Roblox Studio.

AllowBinding

read only
not replicated
read parallel

This property determines whether the PluginAction will be hidden from Studio's shortcuts view. Useful for contextual actions. It defaults to true.

See also:

StatusTip

read only
not replicated
read parallel

The description of the action, when viewing it from the keyboard shortcuts window in Roblox Studio.

Text

read only
not replicated
read parallel

The text that is displayed when viewing this action in Roblox Studio.

Methods

Events

Triggered

Fires when the action is triggered. This can be done by either activating the action from the Quick Access Toolbar, or by using the keyboard shortcut that was bound to it.