Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PluginMenu

A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 9

HistoryMember
731Icon: string
731Title: string
731Visible: bool
573AddAction(action: Instance): null
573AddMenu(menu: Instance): null
462AddNewAction(actionId: string, text: string, icon: string = ): Instance
573AddSeparator(): null
573Clear(): null
462ShowAsync(): Instance
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

PluginMenu represents a context menu which can be shown in Studio to display a list of PluginActions and which also supports submenus. A PluginMenu must be created using the Plugin:CreatePluginMenu() method in order to work as expected.

History 32

Members 9

AddAction

Parameters (1)
actionInstance
Returns (1)
null

Adds the given action to the menu.

SecurityPluginSecurity
Thread safetyUnsafe

History 3

AddMenu

Parameters (1)
menuInstance
Returns (1)
null

Adds the given menu as a separator.

SecurityPluginSecurity
Thread safetyUnsafe

History 3

AddNewAction

Parameters (3)Default
actionIdstring
textstring
iconstring
Returns (1)
Instance

Creates a temporary action that is hidden from Studio's File ⟩ Customize Shortcuts window.

SecurityPluginSecurity
Thread safetyUnsafe

History 2

AddSeparator

Parameters (0)
No parameters.
Returns (1)
null

Adds a separator between items in the menu.

SecurityPluginSecurity
Thread safetyUnsafe

History 3

Clear

Parameters (0)
No parameters.
Returns (1)
null

Clears the menu.

SecurityPluginSecurity
Thread safetyUnsafe

History 3

Icon

TypeDefault
string

This property determines the icon to be displayed when used as a submenu. It defaults to an empty string "".

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

History 6

  • 731 Change Default of Icon from to
  • 726 Change Default of Icon from to
  • 553 Change Default of Icon from to
  • 486 Change ThreadSafety of Icon from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Icon from to ReadOnly
  • 364 Add Icon
Tags: [NotReplicated]

ShowAsync

Parameters (0)
No parameters.
Returns (1)
Instance

Shows the menu at the mouse cursor. It yields until either an item is selected or the menu is closed. The selected action fires its PluginAction.Triggered event.

This function yields. It will block the calling thread until completion.
SecurityPluginSecurity
Thread safetyUnsafe

History 2

Tags: [Yields]

Title

TypeDefault
string

This property determines the text to be displayed when a PluginMenu is used as a submenu. It defaults to an empty string "".

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

History 6

Tags: [NotReplicated]

Visible

TypeDefault
bool

This property determines whether a PluginMenu is shown when it is displayed as a submenu of another menu, that is, when it has been added to a parent menu through PluginMenu:AddMenu(). It defaults to true; setting it to false hides the submenu's entry in its parent menu.

SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

Settings