Class
PluginAction
NotReplicated
Represents a generic performable action in Roblox Studio that can optionally be bound to a keyboard shortcut.
PluginAction represents a generic performable action in Studio with no
directly‑associated PluginToolbarButton. If
AllowBinding is true, the action can be
assigned a keyboard shortcut through Studio's File ⟩ Customize
Shortcuts window.
A PluginAction must be created using the Plugin:CreatePluginAction()
method in order to work as expected.
Properties 4#
ActionIdstring | A string that uniquely identifies this action.ReadSafeReadOnlyNotReplicated |
AllowBindingboolean | Determines whether the action can be assigned a keyboard shortcut in Studio.ReadSafeReadOnlyNotReplicated |
StatusTipstring | The description of the action when viewing it from the keyboard shortcuts window in Roblox Studio.ReadSafeReadOnlyNotReplicated |
Textstring | The text that is displayed when viewing this action in Roblox Studio.Write: RobloxScriptSecurityReadSafeNotReplicated |
ActionId: string#
ReadOnlyNotReplicatedReadSafe
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: boolean#
ReadOnlyNotReplicatedReadSafe
This property determines whether the action can be assigned a keyboard
shortcut through Studio's File ⟩ Customize Shortcuts window.
Default is true.
StatusTip: string#
ReadOnlyNotReplicatedReadSafe
The description of the action when viewing it from the keyboard shortcuts window in Roblox Studio.
Text: string#
NotReplicatedWrite: RobloxScriptSecurityReadSafe
The text that is displayed when viewing this action in Roblox Studio.
Events 1#
| Triggered | Fires when the action is triggered.PluginSecurity security |
Triggered()#
PluginSecurity security
Fires when the action is triggered, typically through the keyboard shortcut that it was bound to.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild