Plugin

Plugin
Not creatableThis class cannot be instantiated.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Memory category	Instances
Subclasses
Inheritance
Object Instance Plugin

The Plugin class inherits from Instance. The class is used to make Roblox Studio widgets and is intended to be used by plugins. This class is special, because, unlike other classes, the object of this class is indexed directly from the plugin keyword, which is only accessible to plugins. Other code can access this object through PluginManager():CreatePlugin().

Properties

CollisionEnabled: bool

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/CollisionEnabled.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

DisableUIDragDetectorDrags: bool

This class member is missing documentation. Create or add to its subpage at Class:Plugin/DisableUIDragDetectorDrags.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

GridSize: float

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GridSize.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

HostDataModelType: StudioDataModelType

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/HostDataModelType.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

HostDataModelTypeIsCurrent: bool

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/HostDataModelTypeIsCurrent.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

MultipleDocumentInterfaceInstance: MultipleDocumentInterfaceInstance

• HiddenThis property is not shown in the object browser and properties window.
• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/MultipleDocumentInterfaceInstance.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

UsesAssetInsertionDrag: bool

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/UsesAssetInsertionDrag.

• Category: Behavior.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

Methods

Activate(exclusiveMouse: bool): null

Parameters

Name	Type
exclusiveMouse	bool

• Security: PluginSecurity.
• Thread safety: unsafe

CreateDockWidgetPluginGui(pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
pluginGuiId	string
dockWidgetPluginGuiInfo	DockWidgetPluginGuiInfo

• Security: PluginSecurity.
• Thread safety: unsafe

CreatePluginAction(actionId: string, text: string, statusTip: string, iconName: string = , allowBinding: bool = true): PluginAction

Parameters

Name	Type	Default
actionId	string
text	string
statusTip	string
iconName	string
allowBinding	bool	true

• Security: PluginSecurity.
• Thread safety: unsafe

CreatePluginMenu(id: string, title: string = , icon: string = ): PluginMenu

Parameters

Name	Type	Default
id	string
title	string
icon	string

• Security: PluginSecurity.
• Thread safety: unsafe

CreateQWidgetPluginGui(pluginGuiId: string, pluginGuiOptions: Dictionary): QWidgetPluginGui

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
pluginGuiId	string
pluginGuiOptions	Dictionary

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

CreateToolbar(name: string): PluginToolbar

Parameters

Name	Type
name	string

• Security: PluginSecurity.
• Thread safety: unsafe

Deactivate(): null

This class member is missing documentation. Create or add to its subpage at Class:Plugin/Deactivate.

• Security: PluginSecurity.
• Thread safety: unsafe

GetItem(key: string, defaultValue: Variant): Variant

Parameters

Name	Type
key	string
defaultValue	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetJoinMode(): JointCreationMode

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GetJoinMode.

• Security: PluginSecurity.
• Thread safety: unsafe

GetMouse(): PluginMouse

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GetMouse.

• Security: PluginSecurity.
• Thread safety: unsafe

GetPluginComponent(name: string): Dictionary

• Custom Lua stateThis member uses the Lua C API directly.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GetPluginComponent.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetSelectedRibbonTool(): RibbonTool

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GetSelectedRibbonTool.

• Security: PluginSecurity.
• Thread safety: unsafe

GetSetting(key: string): Variant

Parameters

Name	Type
key	string

• Security: PluginSecurity.
• Thread safety: unsafe

GetStudioUserId(): int64

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GetStudioUserId.

• Security: PluginSecurity.
• Thread safety: unsafe

GetUri(): Dictionary

This class member is missing documentation. Create or add to its subpage at Class:Plugin/GetUri.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ImportFbxAnimation(rigModel: Instance, isR15: bool = true): Instance

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
rigModel	Instance
isR15	bool	true

• Security: PluginSecurity.
• Thread safety: unsafe

ImportFbxRig(isR15: bool = true): Instance

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
isR15	bool	true

• Security: PluginSecurity.
• Thread safety: unsafe

Intersect(objects: Instances): Instance

Parameters

Name	Type
objects	Instances

• Security: PluginSecurity.
• Thread safety: unsafe

Invoke(key: string, arguments: Tuple): null

Parameters

Name	Type
key	string
arguments	Tuple

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

IsActivated(): bool

This class member is missing documentation. Create or add to its subpage at Class:Plugin/IsActivated.

• Security: PluginSecurity.
• Thread safety: unsafe

IsActivatedWithExclusiveMouse(): bool

This class member is missing documentation. Create or add to its subpage at Class:Plugin/IsActivatedWithExclusiveMouse.

• Security: PluginSecurity.
• Thread safety: unsafe

Negate(objects: Instances): Instances

Parameters

Name	Type
objects	Instances

• Security: PluginSecurity.
• Thread safety: unsafe

OnInvoke(key: string, callback: Function): Instance

Parameters

Name	Type
key	string
callback	Function

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

OnSetItem(key: string, callback: Function): Instance

Parameters

Name	Type
key	string
callback	Function

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

OpenScript(script: LuaSourceContainer, lineNumber: int = 1): null

Parameters

Name	Type	Default
script	LuaSourceContainer
lineNumber	int	1

• Security: PluginSecurity.
• Thread safety: unsafe

OpenWikiPage(url: string): null

Parameters

Name	Type
url	string

• Security: PluginSecurity.
• Thread safety: unsafe

PauseSound(sound: Instance): null

Parameters

Name	Type
sound	Instance

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PlaySound(sound: Instance, normalizedTimePosition: double = 0): null

Parameters

Name	Type	Default
sound	Instance
normalizedTimePosition	double	0

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptForExistingAssetId(assetType: string): int64

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
assetType	string

• Security: PluginSecurity.
• Thread safety: unsafe

PromptSaveSelection(suggestedFileName: string = ): bool

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
suggestedFileName	string

• Security: PluginSecurity.
• Thread safety: unsafe

ResumeSound(sound: Instance): null

Parameters

Name	Type
sound	Instance

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SaveSelectedToRoblox(): null

This class member is missing documentation. Create or add to its subpage at Class:Plugin/SaveSelectedToRoblox.

• Security: PluginSecurity.
• Thread safety: unsafe

SelectRibbonTool(tool: RibbonTool, position: UDim2): null

Parameters

Name	Type
tool	RibbonTool
position	UDim2

• Security: PluginSecurity.
• Thread safety: unsafe

Separate(objects: Instances): Instances

Parameters

Name	Type
objects	Instances

• Security: PluginSecurity.
• Thread safety: unsafe

SetItem(key: string, value: Variant): null

Parameters

Name	Type
key	string
value	Variant

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetReady(): null

This class member is missing documentation. Create or add to its subpage at Class:Plugin/SetReady.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetSetting(key: string, value: Variant): null

Parameters

Name	Type
key	string
value	Variant

• Security: PluginSecurity.
• Thread safety: unsafe

StartDecalDrag(decal: Instance): null

Parameters

Name	Type
decal	Instance

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

StartDrag(dragData: Dictionary): null

Parameters

Name	Type
dragData	Dictionary

• Security: PluginSecurity.
• Thread safety: unsafe

StopAllSounds(): null

This class member is missing documentation. Create or add to its subpage at Class:Plugin/StopAllSounds.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Union(objects: Instances): Instance

Parameters

Name	Type
objects	Instances

• Security: PluginSecurity.
• Thread safety: unsafe

Events

Deactivation()

This class member is missing documentation. Create or add to its subpage at Class:Plugin/Deactivation.

• Security: PluginSecurity.
• Thread safety: unsafe

Ready()

This class member is missing documentation. Create or add to its subpage at Class:Plugin/Ready.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Unloading()

This class member is missing documentation. Create or add to its subpage at Class:Plugin/Unloading.

• Security: PluginSecurity.
• Thread safety: unsafe

Callbacks

ProcessAssetInsertionDrag(assetId: string, assetTypeId: int, instances: Instances): Instances

• NoYieldThis function does not yield the calling thread.

Parameters

Name	Type
assetId	string
assetTypeId	int
instances	Instances

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ProcessAssetInsertionDrop(): null

• NoYieldThis function does not yield the calling thread.

This class member is missing documentation. Create or add to its subpage at Class:Plugin/ProcessAssetInsertionDrop.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Removed members

Methods

• Bind
• BindAndFire
• CreatePluginGui
• Fire
• HasItem
• RemoveItem

Properties

• MDIInstance

External links

• Plugin in the Roblox Creator Documentation
• Plugin in the Roblox API Reference