CreatePluginAction

PluginSecurity

This member cannot be used in scripts, but is usable in the command bar and plugins.

Function of:

Description:

This function creates a PluginAction which is an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button. In Roblox Studio, they can be assigned a keyboard shortcut under File → Advanced → Customize Shortcuts…, and they can also be added to the Quick Access Toolbar.

When an action is triggered, the PluginAction/Triggered event is signaled.

In order for PluginActions work as expected, they must be created using this function.

Parameters

Name	Type	Default	Description
Name actionId	Type string	Default	Summary Must be a unique string that identifies this PluginAction from others
Name text	Type string	Default	Summary The displayed name of the action
Name statusTip	Type string	Default	Summary The displayed description of the action
Name iconName	Type string	Default	Summary The name of the icon used to display the plugin
Name allowBinding	Type bool	Default true	Summary Whether the `PluginAction` will be hidden from Studio’s shortcuts view. Useful for contextual actions. Defaults to true

Returns

Return Type	Summary
Return Type Instance	Summary The newly created PluginAction object

Code Samples

Creating a PluginAction

This code sample visualizes how to create a PluginAction. Plugin actions must be created using the Plugin/CreatePluginAction function in order to work.

In order to work as expected, the code block must but pasted into the command bar, but only once. Consecutive attempts at executing the code in the command bar will result in an error because a plugin cannot create more than one PluginAction with the same id.

After executing the code, the newly created action can be assigned a keyboard shortcut under File → Advanced → Customize Shortcuts…, and can also be added to the Quick Access Toolbar.

File → Advanced → Customize Shortcuts…

Customize Shortcuts Window

When the created action is bound and PluginAction/Triggerd|triggered, it prints “Hello world!” in the output window.

				
					Creating a PluginAction
				
					Expected Output
				
					Expand
					
			local plugin = plugin or getfenv().PluginManager():CreatePlugin()
plugin.Name = "Plugin"

local function actionTriggered()
	print("Hello world!")
end

local pluginAction = plugin:CreatePluginAction("HelloWorldAction", "Hello World", "Prints a 'Hello world!'", "bxasset://textures/sparkle.png", true)

pluginAction.Triggered:Connect(actionTriggered)
		
				Copy Code
			
				Light Theme

CreatePluginAction

See also

Parameters

actionId

text

statusTip

iconName

allowBinding

Returns

Instance

Code Samples

Creating a PluginAction