Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PluginAction

Represents a generic performable action in Roblox Studio that can optionally be bound to a keyboard shortcut.

This class is not replicated. Its interface does not cross the network boundary.
Memory categoryInstances
Tags: [NotReplicated]

Member index 9

HistoryMember
486ActionId: string
731AllowBinding: bool
486StatusTip: string
651Text: string
462Triggered()
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

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.

History 45

Members 9

ActionId

TypeDefault
string

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 3

Tags: [ReadOnly, NotReplicated]

AllowBinding

TypeDefault
booltrue

This property determines whether the action can be assigned a keyboard shortcut through Studio's File ⟩ Customize Shortcuts window. Default is true.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated]

StatusTip

TypeDefault
string

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 3

Tags: [ReadOnly, NotReplicated]

Text

TypeDefault
string

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

This property is not replicated. Its interface does not cross the network boundary.
Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue/false

History 6

  • 651 Change WriteSecurity of Text from None to RobloxScriptSecurity
  • 651 Change Tags of Text from [ReadOnly, NotReplicated] to [NotReplicated]
  • 651 Change CanLoad of Text from false to true
  • 486 Change ThreadSafety of Text from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Text from to ReadOnly
  • 338 Add Text
Tags: [NotReplicated]

Triggered

Parameters (0)
No parameters.

Fires when the action is triggered, typically through the keyboard shortcut that it was bound to.

SecurityPluginSecurity
Thread safetyUnsafe

History 2

Settings