PluginAction

Show Deprecated
Not Replicated

PluginAction is an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or 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

A string that uniquely identifies this action.

READ ONLY
NOT REPLICATED

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

READ ONLY
NOT REPLICATED
HIDDEN
NOT REPLICATED
HIDDEN
NOT REPLICATED
HIDDEN
NOT REPLICATED

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

READ ONLY
NOT REPLICATED

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

READ ONLY
NOT REPLICATED

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.

Methods

Properties

ActionId

Read Only
Not Replicated

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

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

See also:

Checked

Hidden
Not Replicated

DefaultShortcut

Hidden
Not Replicated

Enabled

Hidden
Not Replicated

StatusTip

Read Only
Not Replicated

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

Text

Read Only
Not Replicated

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

Events

Triggered

Plugin Security

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.


Methods