PluginMenu

Mostrar obsoleto
não criável
não replicado

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:

Amostras de código

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)

Resumo

Propriedades

  • Icon:string
    não replicado
    ler parallel

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

  • Title:string
    não replicado
    ler parallel

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

Ver todos os herdados de Instance

Métodos

  • AddAction(action : Instance):void
    segurança do plugin

    Adds the given action to the menu.

  • AddMenu(menu : Instance):void
    segurança do plugin

    Adds the given menu as a separator.

  • AddNewAction(actionId : string,text : string,icon : string):Instance
    segurança do plugin

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

  • AddSeparator():void
    segurança do plugin

    Adds a separator between items in the menu.

  • Clear():void
    segurança do plugin

    Clears the menu.

  • ShowAsync():Instance
    rendimentos
    segurança do plugin

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

Ver todos os herdados de Instance

Propriedades

Icon

string
não replicado
ler parallel

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

Amostras de código

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
não replicado
ler parallel

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

Amostras de código

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)
Ver todos os herdados de Instance

Métodos

AddAction

void
segurança do plugin

Adds the given action to the menu.

Parâmetros

action: Instance

The action to add.


Devolução

void

Amostras de código

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
segurança do plugin

Adds the given menu as a separator.

Parâmetros

menu: Instance

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


Devolução

void

Amostras de código

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
segurança do plugin

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

Parâmetros

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.

Valor Padrão: ""

Devolução

Instance

The created PluginAction.

Amostras de código

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
segurança do plugin

Adds a separator between items in the menu.


Devolução

void

Amostras de código

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
segurança do plugin

Clears the menu.


Devolução

void

ShowAsync

Instance
rendimentos
segurança do plugin

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.


Devolução

Instance

The PluginAction item that was selected or nil.

Amostras de código

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)
Ver todos os herdados de Instance

Eventos

Ver todos os herdados de Instance