Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PluginAction

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

Member index 8

HistoryMember
486ActionId: string
553AllowBinding: bool
486StatusTip: string
651Text: string
462Triggered()
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

History 36

Members 8

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 PluginAction will be hidden from Studio's shortcuts view. Useful for contextual actions. It defaults to true.

See also:

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 4

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. 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.

SecurityPluginSecurity
Thread safetyUnsafe

History 2

Settings