PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

PluginMenu

Show deprecated

PluginMenu

Show deprecated

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

PluginMenus must be created using the Plugin/CreatePluginMenu function in order to work as expected.

See also

  • articles/Intro to Plugins, an introductory article to plugin use and development
  • PluginAction, an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button.
  • Plugin/CreatePluginAction, creates a PluginAction
  • PluginMenu/Title, the text to be displayed when used as a sub menu
  • PluginMenu/Icon, the icon to be displayed when used as a sub menu
  • PluginMenu/AddAction, adds the given action to the menu
  • PluginMenu/AddNewAction, creates a temporary action that is hidden from Studio’s customize shortcuts window
  • PluginMenu/AddMenu, adds the given menu as a separator
  • PluginMenu/AddSeparator, adds a separator between items in the menu
  • PluginMenu/Clear, clears the menu
  • PluginMenu/ShowAsync, shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event

Properties

string

Icon

[NotReplicated]

The icon to be displayed when used as a sub menu

string

Title

[NotReplicated]

The text to be displayed when used as a sub menu

Functions

void

AddAction ( Instance action )

Adds the given action to the menu

void

AddMenu ( Instance menu )

Adds the given menu as a separator

Instance

AddNewAction ( string actionId , string text , string icon )

Creates a temporary action that is hidden from Studio’s customize shortcuts window

  • This function creates a temporary action that is hidden from Studio’s customize shortcuts window.

See also

  • articles/Intro to Plugins, an introductory article to plugin use and development
  • PluginAction, an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button.
  • Plugin/CreatePluginAction, creates a PluginAction
  • PluginMenu/Title, the text to be displayed when used as a sub menu
  • PluginMenu/Icon, the icon to be displayed when used as a sub menu
  • PluginMenu/AddAction, adds the given action to the menu
  • PluginMenu/AddMenu, adds the given menu as a separator
  • PluginMenu/AddSeparator, adds a separator between items in the menu
  • PluginMenu/Clear, clears the menu
  • PluginMenu/ShowAsync, shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event
void

AddSeparator ( )

Adds a separator between items in the menu

void

Clear ( )

Clears the menu

Instance

ShowAsync ( )

[Yields]

Shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed

Events