PluginMenu

Afficher les obsolètes
création impossible
non répliqué

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:

Échantillons de code

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)

Résumé

Propriétés

  • Icon:string
    non répliqué
    lecture parallèle

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

  • Title:string
    non répliqué
    lecture parallèle

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

Afficher tous les hérités de Instance

Méthodes

  • AddAction(action : Instance):void
    sécurité des plugins

    Adds the given action to the menu.

  • AddMenu(menu : Instance):void
    sécurité des plugins

    Adds the given menu as a separator.

  • AddNewAction(actionId : string,text : string,icon : string):Instance
    sécurité des plugins

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

  • AddSeparator():void
    sécurité des plugins

    Adds a separator between items in the menu.

  • Clear():void
    sécurité des plugins

    Clears the menu.

  • ShowAsync():Instance
    rendement
    sécurité des plugins

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

Afficher tous les hérités de Instance

Propriétés

Icon

string
non répliqué
lecture parallèle

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

Échantillons de code

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
non répliqué
lecture parallèle

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

Échantillons de code

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)
Afficher tous les hérités de Instance

Méthodes

AddAction

void
sécurité des plugins

Adds the given action to the menu.

Paramètres

action: Instance

The action to add.


Retours

void

Échantillons de code

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
sécurité des plugins

Adds the given menu as a separator.

Paramètres

menu: Instance

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


Retours

void

Échantillons de code

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
sécurité des plugins

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

Paramètres

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.

Valeur par défaut : ""

Retours

Instance

The created PluginAction.

Échantillons de code

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
sécurité des plugins

Adds a separator between items in the menu.


Retours

void

Échantillons de code

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
sécurité des plugins

Clears the menu.


Retours

void

ShowAsync

Instance
rendement
sécurité des plugins

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.


Retours

Instance

The PluginAction item that was selected or nil.

Échantillons de code

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)
Afficher tous les hérités de Instance

Évènements

Afficher tous les hérités de Instance