Engine
GuidesTutorialsReferenceResourcesArtDesign

PluginMenu

Show Deprecated
not creatable
not replicated

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:

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)

Summary

Properties

  • Icon:string
    not replicated
    read parallel

    The icon to be displayed when used as a sub menu.

  • Title:string
    not replicated
    read parallel

    The text to be displayed when used as a sub menu.

View all inherited from Instance

Methods

  • AddAction(action: Instance):void
    plugin security

    Adds the given action to the menu.

  • AddMenu(menu: Instance):void
    plugin security

    Adds the given menu as a separator.

  • AddNewAction(actionId: string,text: string,icon: string):Instance
    plugin security

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

  • AddSeparator():void
    plugin security

    Adds a separator between items in the menu.

  • Clear():void
    plugin security

    Clears the menu.

  • ShowAsync():Instance
    yields
    plugin security

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

View all inherited from Instance

Properties

Icon

string
not replicated
read parallel

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

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)

Title

string
not replicated
read parallel

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

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)
View all inherited from Instance

Methods

AddAction

void
plugin security

Adds the given action to the menu.

Parameters

action: Instance

The action to add.


Returns

void

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)

AddMenu

void
plugin security

Adds the given menu as a separator.

Parameters

menu: Instance

The menu to add as a sub menu. Uses its PluginMenu.Title and PluginMenu.Icon to display.


Returns

void

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)

AddNewAction

Instance
plugin security

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

Parameters

actionId: string

Must be a unique string that identifies this PluginAction from others.

text: string

The text to be displayed.

icon: string

The icon to be displayed.

Default Value: ""

Returns

Instance

The created PluginAction.

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)

AddSeparator

void
plugin security

Adds a separator between items in the menu.


Returns

void

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)

Clear

void
plugin security

Clears the menu.


Returns

void

ShowAsync

Instance
yields
plugin security

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.


Returns

Instance

The PluginAction item that was selected or nil.

Code Samples

Creating a PluginMenu and PluginMenuAction
-- This code can be pasted into the command bar, but only once.



local plugin = plugin or getfenv().PluginManager():CreatePlugin()

plugin.Name = "Plugin"

plugin.Parent = workspace



local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")

pluginMenu.Name = "Test Menu"



pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")

pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")



local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")

subMenu.Name = "Sub Menu"



subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")

subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")



pluginMenu:AddMenu(subMenu)

pluginMenu:AddSeparator()



pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")



local toggle = Instance.new("BoolValue")

toggle.Name = "TogglePluginMenu"

toggle.Parent = workspace



local function onToggled()

	if toggle.Value then

		toggle.Value = false



		local selectedAction = pluginMenu:ShowAsync()

		if selectedAction then

			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)

		else

			print("User did not select an action!")

		end

	end

end



toggle.Changed:Connect(onToggled)
View all inherited from Instance

Events

View all inherited from Instance