PluginMenu

非推奨を表示
作成できません
複製されていません

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:

コードサンプル

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)

概要

プロパティ

  • Icon:string
    複製されていません
    並列読み取り

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

  • Title:string
    複製されていません
    並列読み取り

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

Instance から継承されたものをすべて表示

方法

  • AddAction(action : Instance):void
    プラグインのセキュリティ

    Adds the given action to the menu.

  • AddMenu(menu : Instance):void
    プラグインのセキュリティ

    Adds the given menu as a separator.

  • AddNewAction(actionId : string,text : string,icon : string):Instance
    プラグインのセキュリティ

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

  • AddSeparator():void
    プラグインのセキュリティ

    Adds a separator between items in the menu.

  • Clear():void
    プラグインのセキュリティ

    Clears the menu.

  • ShowAsync():Instance
    イールド
    プラグインのセキュリティ

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

Instance から継承されたものをすべて表示

プロパティ

Icon

string
複製されていません
並列読み取り

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

コードサンプル

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
複製されていません
並列読み取り

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

コードサンプル

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)
Instance から継承されたものをすべて表示

方法

AddAction

void
プラグインのセキュリティ

Adds the given action to the menu.

パラメータ

action: Instance

The action to add.


戻り値

void

コードサンプル

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
プラグインのセキュリティ

Adds the given menu as a separator.

パラメータ

menu: Instance

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


戻り値

void

コードサンプル

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
プラグインのセキュリティ

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

パラメータ

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.

既定値: ""

戻り値

Instance

The created PluginAction.

コードサンプル

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
プラグインのセキュリティ

Adds a separator between items in the menu.


戻り値

void

コードサンプル

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
プラグインのセキュリティ

Clears the menu.


戻り値

void

ShowAsync

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.


戻り値

Instance

The PluginAction item that was selected or nil.

コードサンプル

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)
Instance から継承されたものをすべて表示

イベント

Instance から継承されたものをすべて表示