Plugin On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

Memory Category	Instances
ExplorerImageIndex	86 ()
ExplorerOrder	30

Tags: [NotCreatable]

Inherits (1)

Instance

Member index (50)

Type	Member	History
bool	CollisionEnabled	196
float	GridSize	196
StudioDataModelType	HostDataModelType	398 400 400 407 407 421 421 433 433 469
bool	HostDataModelTypeIsCurrent	402 407 407 421 421 433 433 469
MultipleDocumentInterfaceInstance	MultipleDocumentInterfaceInstance	408 421 421 433 433 469
bool	UsesAssetInsertionDrag	354 469 469
null	Activate (bool exclusiveMouse)	71 150 151 573
DockWidgetPluginGui	CreateDockWidgetPluginGui (string pluginGuiId, DockWidgetPluginGuiInfo dockWidgetPluginGuiInfo)	326 483
PluginAction	CreatePluginAction (string actionId, string text, string statusTip, string iconName = , bool allowBinding = true)	338 345 364 483
PluginMenu	CreatePluginMenu (string id, string title = , string icon = )	364 483
QWidgetPluginGui	CreateQWidgetPluginGui (string pluginGuiId, Dictionary pluginGuiOptions)	351 350 351 483
PluginToolbar	CreateToolbar (string name)	150 151 483
null	Deactivate ()	330 573
Variant	GetItem (string key, Variant defaultValue)	398 400 407 408 408 421 433
JointCreationMode	GetJoinMode ()	196
PluginMouse	GetMouse ()	150 151 483
RibbonTool	GetSelectedRibbonTool ()	301
Variant	GetSetting (string key)	128 150 151
int64	GetStudioUserId ()	128 150 151 322 418
Instance	ImportFbxAnimation (Instance rigModel, bool isR15 = true)	256 371 371 377
Instance	ImportFbxRig (bool isR15 = true)	256 265 265 264 264 265 265 377
Instance	Intersect (Objects objects)	568
null	Invoke (string key, Tuple arguments)	408 421 433 573
bool	IsActivated ()	330
bool	IsActivatedWithExclusiveMouse ()	330
Objects	Negate (Objects objects)	190
Instance	OnInvoke (string key, Function callback)	408 421 433
Instance	OnSetItem (string key, Function callback)	408 421 433
null	OpenScript (LuaSourceContainer script, int lineNumber = 1)	144 150 151 301 492 573
null	OpenWikiPage (string url)	213 573
null	PauseSound (Instance sound)	345 460 573
null	PlaySound (Instance sound, double normalizedTimePosition = 0)	345 449 460 573
int64	PromptForExistingAssetId (string assetType)	220 224 224 322
bool	PromptSaveSelection (string suggestedFileName = )	268
null	ResumeSound (Instance sound)	345 460 573
null	SaveSelectedToRoblox ()	128 150 151 573
null	SelectRibbonTool (RibbonTool tool, UDim2 position)	277 573
Objects	Separate (Objects objects)	190
null	SetItem (string key, Variant value)	398 400 407 408 421 433 573
null	SetReady ()	493 573
null	SetSetting (string key, Variant value)	128 150 151 573
null	StartDecalDrag (Instance decal)	355 573
null	StartDrag (Dictionary dragData)	354 366 366 573
null	StopAllSounds ()	345 573
Instance	Union (Objects objects)	190
	Deactivation ()	150 151
	Ready ()	493
	Unloading ()	370
Objects	ProcessAssetInsertionDrag (string assetId, int assetTypeId, Objects instances)	532
null	ProcessAssetInsertionDrop ()	532 573
57 members inherited from Instance

Removed member index (7)

Type	Member	History
MDIInstance	MDIInstance	399 407 407 408
Instance	Bind (string key, Function callback)	398 400 407 408
Instance	BindAndFire (string key, Function callback)	398 400 407 408
Instance	CreatePluginGui (string pluginGuiName, bool restoreEnabledState, bool initialEnabledState)	319 323 326
void	Fire (string key, string value = )	398 400 407 408
bool	HasItem (string key)	398 400 407 408
bool	RemoveItem (string key)	398 400 407 408

573 Change ReturnType of Plugin.Activate from void to null
573 Change ReturnType of Plugin.Deactivate from void to null
573 Change ReturnType of Plugin.Invoke from void to null
573 Change ReturnType of Plugin.OpenScript from void to null
573 Change ReturnType of Plugin.OpenWikiPage from void to null
573 Change ReturnType of Plugin.PauseSound from void to null
573 Change ReturnType of Plugin.PlaySound from void to null
573 Change ReturnType of Plugin.ResumeSound from void to null
573 Change ReturnType of Plugin.SaveSelectedToRoblox from void to null
573 Change ReturnType of Plugin.SelectRibbonTool from void to null
573 Change ReturnType of Plugin.SetItem from void to null
573 Change ReturnType of Plugin.SetReady from void to null
573 Change ReturnType of Plugin.SetSetting from void to null
573 Change ReturnType of Plugin.StartDecalDrag from void to null
573 Change ReturnType of Plugin.StartDrag from void to null
573 Change ReturnType of Plugin.StopAllSounds from void to null
573 Change ReturnType of Plugin.ProcessAssetInsertionDrop from void to null
568 Add Plugin.Intersect
532 Add Plugin.ProcessAssetInsertionDrag
532 Add Plugin.ProcessAssetInsertionDrop
493 Add Plugin.SetReady
493 Add Plugin.Ready
492 Change Parameters of Plugin.OpenScript from (Instance script, int lineNumber = 1) to (LuaSourceContainer script, int lineNumber = 1)
483 Change ReturnType of Plugin.CreateDockWidgetPluginGui from Instance to DockWidgetPluginGui
483 Change ReturnType of Plugin.CreatePluginAction from Instance to PluginAction
483 Change ReturnType of Plugin.CreatePluginMenu from Instance to PluginMenu
483 Change ReturnType of Plugin.CreateQWidgetPluginGui from Instance to QWidgetPluginGui
483 Change ReturnType of Plugin.CreateToolbar from Instance to PluginToolbar
483 Change ReturnType of Plugin.GetMouse from Instance to PluginMouse
469 Change Tags of Plugin.HostDataModelType from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of Plugin.HostDataModelTypeIsCurrent from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change Tags of Plugin.MultipleDocumentInterfaceInstance from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
469 Change CanLoad of Plugin.UsesAssetInsertionDrag from true to false
469 Change Tags of Plugin.UsesAssetInsertionDrag from [NotReplicated] to [Hidden, NotReplicated]
460 Change Parameters of Plugin.PauseSound from (Instance soundChannel) to (Instance sound)
460 Change Parameters of Plugin.PlaySound from (Instance soundChannel, double normalizedTimePosition = 0) to (Instance sound, double normalizedTimePosition = 0)
460 Change Parameters of Plugin.ResumeSound from (Instance soundChannel) to (Instance sound)
449 Change Parameters of Plugin.PlaySound from (Instance soundChannel) to (Instance soundChannel, double normalizedTimePosition = 0)
433 Change ReadSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
433 Change WriteSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
433 Change ReadSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
433 Change WriteSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
433 Change ReadSecurity of Plugin.MultipleDocumentInterfaceInstance from PluginSecurity to RobloxScriptSecurity
433 Change WriteSecurity of Plugin.MultipleDocumentInterfaceInstance from PluginSecurity to RobloxScriptSecurity
433 Change Security of Plugin.GetItem from PluginSecurity to RobloxScriptSecurity
433 Change Security of Plugin.Invoke from PluginSecurity to RobloxScriptSecurity
433 Change Security of Plugin.OnInvoke from PluginSecurity to RobloxScriptSecurity
433 Change Security of Plugin.OnSetItem from PluginSecurity to RobloxScriptSecurity
433 Change Security of Plugin.SetItem from PluginSecurity to RobloxScriptSecurity
421 Change ReadSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
421 Change WriteSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
421 Change ReadSecurity of Plugin.HostDataModelTypeIsCurrent from RobloxScriptSecurity to PluginSecurity
421 Change WriteSecurity of Plugin.HostDataModelTypeIsCurrent from RobloxScriptSecurity to PluginSecurity
421 Change ReadSecurity of Plugin.MultipleDocumentInterfaceInstance from RobloxScriptSecurity to PluginSecurity
421 Change WriteSecurity of Plugin.MultipleDocumentInterfaceInstance from RobloxScriptSecurity to PluginSecurity
421 Change Security of Plugin.GetItem from RobloxScriptSecurity to PluginSecurity
421 Change Security of Plugin.Invoke from RobloxScriptSecurity to PluginSecurity
421 Change Security of Plugin.OnInvoke from RobloxScriptSecurity to PluginSecurity
421 Change Security of Plugin.OnSetItem from RobloxScriptSecurity to PluginSecurity
421 Change Security of Plugin.SetItem from RobloxScriptSecurity to PluginSecurity
418 Change Tags of Plugin.GetStudioUserId from [] to [Deprecated]
408 Remove Plugin.MDIInstance
408 Add Plugin.MultipleDocumentInterfaceInstance
408 Remove Plugin.Bind
408 Remove Plugin.BindAndFire
408 Remove Plugin.Fire
408 Change Parameters of Plugin.GetItem from (string key, string defaultValue = ) to (string key, Variant defaultValue)
408 Change ReturnType of Plugin.GetItem from string to Variant
408 Remove Plugin.HasItem
408 Add Plugin.Invoke
408 Add Plugin.OnInvoke
408 Add Plugin.OnSetItem
408 Remove Plugin.RemoveItem
408 Change Parameters of Plugin.SetItem from (string key, string value = ) to (string key, Variant value)
407 Change ReadSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
407 Change WriteSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
407 Change ReadSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
407 Change WriteSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
407 Change ReadSecurity of Plugin.MDIInstance from PluginSecurity to RobloxScriptSecurity
407 Change WriteSecurity of Plugin.MDIInstance from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.Bind from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.BindAndFire from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.Fire from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.GetItem from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.HasItem from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.RemoveItem from PluginSecurity to RobloxScriptSecurity
407 Change Security of Plugin.SetItem from PluginSecurity to RobloxScriptSecurity
402 Add Plugin.HostDataModelTypeIsCurrent
400 Change ReadSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
400 Change WriteSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.Bind from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.BindAndFire from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.Fire from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.GetItem from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.HasItem from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.RemoveItem from RobloxScriptSecurity to PluginSecurity
400 Change Security of Plugin.SetItem from RobloxScriptSecurity to PluginSecurity
399 Add Plugin.MDIInstance
398 Add Plugin.HostDataModelType
398 Add Plugin.Bind
398 Add Plugin.BindAndFire
398 Add Plugin.Fire
398 Add Plugin.GetItem
398 Add Plugin.HasItem
398 Add Plugin.RemoveItem
398 Add Plugin.SetItem
377 Change Parameters of Plugin.ImportFbxAnimation from (Instance rigModel) to (Instance rigModel, bool isR15 = true)
377 Change Parameters of Plugin.ImportFbxRig from () to (bool isR15 = true)
371 Change ReturnType of Plugin.ImportFbxAnimation from void to Instance
371 Change Tags of Plugin.ImportFbxAnimation from [] to [Yields]
370 Add Plugin.Unloading
366 Change Parameters of Plugin.StartDrag from (PluginDrag drag) to (Dictionary dragData)
366 Change Security of Plugin.StartDrag from RobloxScriptSecurity to PluginSecurity
364 Change Parameters of Plugin.CreatePluginAction from (string actionId, string text, string statusTip, string iconName = ) to (string actionId, string text, string statusTip, string iconName = , bool allowBinding = true)
364 Add Plugin.CreatePluginMenu
355 Add Plugin.StartDecalDrag
354 Add Plugin.UsesAssetInsertionDrag
354 Add Plugin.StartDrag
351 Add Plugin.CreateQWidgetPluginGui
350 Remove Plugin.CreateQWidgetPluginGui
351 Add Plugin.CreateQWidgetPluginGui
345 Change Parameters of Plugin.CreatePluginAction from (string actionId, string text, string statusTip) to (string actionId, string text, string statusTip, string iconName = )
345 Add Plugin.PauseSound
345 Add Plugin.PlaySound
345 Add Plugin.ResumeSound
345 Add Plugin.StopAllSounds
338 Add Plugin.CreatePluginAction
330 Add Plugin.Deactivate
330 Add Plugin.IsActivated
330 Add Plugin.IsActivatedWithExclusiveMouse
326 Add Plugin.CreateDockWidgetPluginGui
326 Remove Plugin.CreatePluginGui
323 Change Parameters of Plugin.CreatePluginGui from (string pluginGuiId) to (string pluginGuiName, bool restoreEnabledState, bool initialEnabledState)
322 Change ReturnType of Plugin.GetStudioUserId from int to int64
322 Change ReturnType of Plugin.PromptForExistingAssetId from int to int64
319 Add Plugin.CreatePluginGui
301 Add Plugin.GetSelectedRibbonTool
301 Change Parameters of Plugin.OpenScript from (Instance script, int lineNumber = 0) to (Instance script, int lineNumber = 1)
277 Add Plugin.SelectRibbonTool
268 Add Plugin.PromptSaveSelection
265 Change ReturnType of Plugin.ImportFbxRig from void to Instance
265 Change Tags of Plugin.ImportFbxRig from [] to [Yields]
264 Change ReturnType of Plugin.ImportFbxRig from Instance to void
264 Change Tags of Plugin.ImportFbxRig from [Yields] to []
265 Change ReturnType of Plugin.ImportFbxRig from void to Instance
265 Change Tags of Plugin.ImportFbxRig from [] to [Yields]
256 Add Plugin.ImportFbxAnimation
256 Add Plugin.ImportFbxRig
224 Change Parameters of Plugin.PromptForExistingAssetId from (int assetId = -1) to (string assetType)
224 Change Tags of Plugin.PromptForExistingAssetId from [] to [Yields]
220 Add Plugin.PromptForExistingAssetId
213 Add Plugin.OpenWikiPage
196 Add Plugin.CollisionEnabled
196 Add Plugin.GridSize
196 Add Plugin.GetJoinMode
190 Add Plugin.Negate
190 Add Plugin.Separate
190 Add Plugin.Union
151 Change Security of Plugin.Activate from security1 to PluginSecurity
151 Change Security of Plugin.CreateToolbar from security1 to PluginSecurity
151 Change Security of Plugin.GetMouse from security1 to PluginSecurity
151 Change Security of Plugin.GetSetting from security1 to PluginSecurity
151 Change Security of Plugin.GetStudioUserId from security1 to PluginSecurity
151 Change Security of Plugin.OpenScript from security1 to PluginSecurity
151 Change Security of Plugin.SaveSelectedToRoblox from security1 to PluginSecurity
151 Change Security of Plugin.SetSetting from security1 to PluginSecurity
151 Change Security of Plugin.Deactivation from security1 to PluginSecurity
150 Change Security of Plugin.Activate from LocalUserSecurity to security1
150 Change Security of Plugin.CreateToolbar from LocalUserSecurity to security1
150 Change Security of Plugin.GetMouse from LocalUserSecurity to security1
150 Change Security of Plugin.GetSetting from LocalUserSecurity to security1
150 Change Security of Plugin.GetStudioUserId from LocalUserSecurity to security1
150 Change Security of Plugin.OpenScript from LocalUserSecurity to security1
150 Change Security of Plugin.SaveSelectedToRoblox from LocalUserSecurity to security1
150 Change Security of Plugin.SetSetting from LocalUserSecurity to security1
150 Change Security of Plugin.Deactivation from None to security1
144 Add Plugin.OpenScript
128 Add Plugin.GetSetting
128 Add Plugin.GetStudioUserId
128 Add Plugin.SaveSelectedToRoblox
128 Add Plugin.SetSetting
79 Change Tags of Plugin from [preliminary, NotCreatable] to [NotCreatable]
78 Change Tags of Plugin from [NotCreatable] to [preliminary, NotCreatable]
79 Change Tags of Plugin from [preliminary, NotCreatable] to [NotCreatable]
71 Change Parameters of Plugin.Activate from (bool ExclusiveMouse) to (bool exclusiveMouse)

Members

Activate On DevHub

Parameters	1

Name	Type	Default
exclusiveMouse	bool	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.Activate from void to null
151 Change Security of Plugin.Activate from security1 to PluginSecurity
150 Change Security of Plugin.Activate from LocalUserSecurity to security1
71 Change Parameters of Plugin.Activate from (bool ExclusiveMouse) to (bool exclusiveMouse)

CollisionEnabled On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

196 Add Plugin.CollisionEnabled

Tags: [ReadOnly, NotReplicated]

CreateDockWidgetPluginGui On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
pluginGuiId	string	none
dockWidgetPluginGuiInfo	DockWidgetPluginGuiInfo	none

Return Type	DockWidgetPluginGui
Security	PluginSecurity

History

483 Change ReturnType of Plugin.CreateDockWidgetPluginGui from Instance to DockWidgetPluginGui
326 Add Plugin.CreateDockWidgetPluginGui

Tags: [Yields]

CreatePluginAction On DevHub

Parameters	5

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

Return Type	PluginAction
Security	PluginSecurity

History

483 Change ReturnType of Plugin.CreatePluginAction from Instance to PluginAction
364 Change Parameters of Plugin.CreatePluginAction from (string actionId, string text, string statusTip, string iconName = ) to (string actionId, string text, string statusTip, string iconName = , bool allowBinding = true)
345 Change Parameters of Plugin.CreatePluginAction from (string actionId, string text, string statusTip) to (string actionId, string text, string statusTip, string iconName = )
338 Add Plugin.CreatePluginAction

CreatePluginMenu On DevHub

Parameters	3

Name	Type	Default
id	string	none
title	string
icon	string

Return Type	PluginMenu
Security	PluginSecurity

History

483 Change ReturnType of Plugin.CreatePluginMenu from Instance to PluginMenu
364 Add Plugin.CreatePluginMenu

CreateQWidgetPluginGui On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
pluginGuiId	string	none
pluginGuiOptions	Dictionary	none

Return Type	QWidgetPluginGui
Security	RobloxScriptSecurity

History

483 Change ReturnType of Plugin.CreateQWidgetPluginGui from Instance to QWidgetPluginGui
351 Add Plugin.CreateQWidgetPluginGui
350 Remove Plugin.CreateQWidgetPluginGui
351 Add Plugin.CreateQWidgetPluginGui

Tags: [Yields]

CreateToolbar On DevHub

Parameters	1

Name	Type	Default
name	string	none

Return Type	PluginToolbar
Security	PluginSecurity

History

483 Change ReturnType of Plugin.CreateToolbar from Instance to PluginToolbar
151 Change Security of Plugin.CreateToolbar from security1 to PluginSecurity
150 Change Security of Plugin.CreateToolbar from LocalUserSecurity to security1

Deactivate On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.Deactivate from void to null
330 Add Plugin.Deactivate

Deactivation On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	PluginSecurity

History

151 Change Security of Plugin.Deactivation from security1 to PluginSecurity
150 Change Security of Plugin.Deactivation from None to security1

GetItem On DevHub

Parameters	2

Name	Type	Default
key	string	none
defaultValue	Variant	none

Return Type	Variant
Security	RobloxScriptSecurity

History

433 Change Security of Plugin.GetItem from PluginSecurity to RobloxScriptSecurity
421 Change Security of Plugin.GetItem from RobloxScriptSecurity to PluginSecurity
408 Change Parameters of Plugin.GetItem from (string key, string defaultValue = ) to (string key, Variant defaultValue)
408 Change ReturnType of Plugin.GetItem from string to Variant
407 Change Security of Plugin.GetItem from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.GetItem from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.GetItem

GetJoinMode On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	JointCreationMode
Security	PluginSecurity

History

196 Add Plugin.GetJoinMode

GetMouse On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	PluginMouse
Security	PluginSecurity

History

483 Change ReturnType of Plugin.GetMouse from Instance to PluginMouse
151 Change Security of Plugin.GetMouse from security1 to PluginSecurity
150 Change Security of Plugin.GetMouse from LocalUserSecurity to security1

GetSelectedRibbonTool On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	RibbonTool
Security	PluginSecurity

History

301 Add Plugin.GetSelectedRibbonTool

GetSetting On DevHub

Parameters	1

Name	Type	Default
key	string	none

Return Type	Variant
Security	PluginSecurity

History

151 Change Security of Plugin.GetSetting from security1 to PluginSecurity
150 Change Security of Plugin.GetSetting from LocalUserSecurity to security1
128 Add Plugin.GetSetting

GetStudioUserId On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	int64
Security	PluginSecurity

History

418 Change Tags of Plugin.GetStudioUserId from [] to [Deprecated]
322 Change ReturnType of Plugin.GetStudioUserId from int to int64
151 Change Security of Plugin.GetStudioUserId from security1 to PluginSecurity
150 Change Security of Plugin.GetStudioUserId from LocalUserSecurity to security1
128 Add Plugin.GetStudioUserId

Tags: [Deprecated]

GridSize On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	float
Category	Data
Can Load	false
Can Save	false

History

196 Add Plugin.GridSize

Tags: [ReadOnly, NotReplicated]

HostDataModelType On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	StudioDataModelType
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Plugin.HostDataModelType from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
433 Change ReadSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
433 Change WriteSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
421 Change ReadSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
421 Change WriteSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
407 Change ReadSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
407 Change WriteSecurity of Plugin.HostDataModelType from PluginSecurity to RobloxScriptSecurity
400 Change ReadSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
400 Change WriteSecurity of Plugin.HostDataModelType from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.HostDataModelType

Tags: [Hidden, ReadOnly, NotReplicated]

HostDataModelTypeIsCurrent On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Plugin.HostDataModelTypeIsCurrent from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
433 Change ReadSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
433 Change WriteSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
421 Change ReadSecurity of Plugin.HostDataModelTypeIsCurrent from RobloxScriptSecurity to PluginSecurity
421 Change WriteSecurity of Plugin.HostDataModelTypeIsCurrent from RobloxScriptSecurity to PluginSecurity
407 Change ReadSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
407 Change WriteSecurity of Plugin.HostDataModelTypeIsCurrent from PluginSecurity to RobloxScriptSecurity
402 Add Plugin.HostDataModelTypeIsCurrent

Tags: [Hidden, ReadOnly, NotReplicated]

ImportFbxAnimation On DevHub

This function yields. It will block the calling thread until completion.

Parameters	2

Name	Type	Default
rigModel	Instance	none
isR15	bool	true

Return Type	Instance
Security	PluginSecurity

History

377 Change Parameters of Plugin.ImportFbxAnimation from (Instance rigModel) to (Instance rigModel, bool isR15 = true)
371 Change ReturnType of Plugin.ImportFbxAnimation from void to Instance
371 Change Tags of Plugin.ImportFbxAnimation from [] to [Yields]
256 Add Plugin.ImportFbxAnimation

Tags: [Yields]

ImportFbxRig On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
isR15	bool	true

Return Type	Instance
Security	PluginSecurity

History

377 Change Parameters of Plugin.ImportFbxRig from () to (bool isR15 = true)
265 Change ReturnType of Plugin.ImportFbxRig from void to Instance
265 Change Tags of Plugin.ImportFbxRig from [] to [Yields]
264 Change ReturnType of Plugin.ImportFbxRig from Instance to void
264 Change Tags of Plugin.ImportFbxRig from [Yields] to []
265 Change ReturnType of Plugin.ImportFbxRig from void to Instance
265 Change Tags of Plugin.ImportFbxRig from [] to [Yields]
256 Add Plugin.ImportFbxRig

Tags: [Yields]

Intersect On DevHub

Parameters	1

Name	Type	Default
objects	Objects	none

Return Type	Instance
Security	PluginSecurity

History

568 Add Plugin.Intersect

Invoke On DevHub

Parameters	2

Name	Type	Default
key	string	none
arguments	Tuple	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.Invoke from void to null
433 Change Security of Plugin.Invoke from PluginSecurity to RobloxScriptSecurity
421 Change Security of Plugin.Invoke from RobloxScriptSecurity to PluginSecurity
408 Add Plugin.Invoke

IsActivated On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	PluginSecurity

History

330 Add Plugin.IsActivated

IsActivatedWithExclusiveMouse On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	PluginSecurity

History

330 Add Plugin.IsActivatedWithExclusiveMouse

MultipleDocumentInterfaceInstance On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	MultipleDocumentInterfaceInstance
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

469 Change Tags of Plugin.MultipleDocumentInterfaceInstance from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
433 Change ReadSecurity of Plugin.MultipleDocumentInterfaceInstance from PluginSecurity to RobloxScriptSecurity
433 Change WriteSecurity of Plugin.MultipleDocumentInterfaceInstance from PluginSecurity to RobloxScriptSecurity
421 Change ReadSecurity of Plugin.MultipleDocumentInterfaceInstance from RobloxScriptSecurity to PluginSecurity
421 Change WriteSecurity of Plugin.MultipleDocumentInterfaceInstance from RobloxScriptSecurity to PluginSecurity
408 Add Plugin.MultipleDocumentInterfaceInstance

Tags: [Hidden, ReadOnly, NotReplicated]

Negate On DevHub

Parameters	1

Name	Type	Default
objects	Objects	none

Return Type	Objects
Security	PluginSecurity

History

190 Add Plugin.Negate

OnInvoke On DevHub

Parameters	2

Name	Type	Default
key	string	none
callback	Function	none

Return Type	Instance
Security	RobloxScriptSecurity

History

433 Change Security of Plugin.OnInvoke from PluginSecurity to RobloxScriptSecurity
421 Change Security of Plugin.OnInvoke from RobloxScriptSecurity to PluginSecurity
408 Add Plugin.OnInvoke

OnSetItem On DevHub

Parameters	2

Name	Type	Default
key	string	none
callback	Function	none

Return Type	Instance
Security	RobloxScriptSecurity

History

433 Change Security of Plugin.OnSetItem from PluginSecurity to RobloxScriptSecurity
421 Change Security of Plugin.OnSetItem from RobloxScriptSecurity to PluginSecurity
408 Add Plugin.OnSetItem

OpenScript On DevHub

Parameters	2

Name	Type	Default
script	LuaSourceContainer	none
lineNumber	int	1

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.OpenScript from void to null
492 Change Parameters of Plugin.OpenScript from (Instance script, int lineNumber = 1) to (LuaSourceContainer script, int lineNumber = 1)
301 Change Parameters of Plugin.OpenScript from (Instance script, int lineNumber = 0) to (Instance script, int lineNumber = 1)
151 Change Security of Plugin.OpenScript from security1 to PluginSecurity
150 Change Security of Plugin.OpenScript from LocalUserSecurity to security1
144 Add Plugin.OpenScript

OpenWikiPage On DevHub

Parameters	1

Name	Type	Default
url	string	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.OpenWikiPage from void to null
213 Add Plugin.OpenWikiPage

PauseSound On DevHub

Parameters	1

Name	Type	Default
sound	Instance	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.PauseSound from void to null
460 Change Parameters of Plugin.PauseSound from (Instance soundChannel) to (Instance sound)
345 Add Plugin.PauseSound

PlaySound On DevHub

Parameters	2

Name	Type	Default
sound	Instance	none
normalizedTimePosition	double	0

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.PlaySound from void to null
460 Change Parameters of Plugin.PlaySound from (Instance soundChannel, double normalizedTimePosition = 0) to (Instance sound, double normalizedTimePosition = 0)
449 Change Parameters of Plugin.PlaySound from (Instance soundChannel) to (Instance soundChannel, double normalizedTimePosition = 0)
345 Add Plugin.PlaySound

ProcessAssetInsertionDrag On DevHub

Parameters	3

Name	Type	Default
assetId	string	none
assetTypeId	int	none
instances	Objects	none

Return Type	Objects
Security	RobloxScriptSecurity

History

532 Add Plugin.ProcessAssetInsertionDrag

Tags: [NoYield]

ProcessAssetInsertionDrop On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.ProcessAssetInsertionDrop from void to null
532 Add Plugin.ProcessAssetInsertionDrop

Tags: [NoYield]

PromptForExistingAssetId On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
assetType	string	none

Return Type	int64
Security	PluginSecurity

History

322 Change ReturnType of Plugin.PromptForExistingAssetId from int to int64
224 Change Parameters of Plugin.PromptForExistingAssetId from (int assetId = -1) to (string assetType)
224 Change Tags of Plugin.PromptForExistingAssetId from [] to [Yields]
220 Add Plugin.PromptForExistingAssetId

Tags: [Yields]

PromptSaveSelection On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
suggestedFileName	string

Return Type	bool
Security	PluginSecurity

History

268 Add Plugin.PromptSaveSelection

Tags: [Yields]

Ready On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

493 Add Plugin.Ready

ResumeSound On DevHub

Parameters	1

Name	Type	Default
sound	Instance	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.ResumeSound from void to null
460 Change Parameters of Plugin.ResumeSound from (Instance soundChannel) to (Instance sound)
345 Add Plugin.ResumeSound

SaveSelectedToRoblox On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.SaveSelectedToRoblox from void to null
151 Change Security of Plugin.SaveSelectedToRoblox from security1 to PluginSecurity
150 Change Security of Plugin.SaveSelectedToRoblox from LocalUserSecurity to security1
128 Add Plugin.SaveSelectedToRoblox

SelectRibbonTool On DevHub

Parameters	2

Name	Type	Default
tool	RibbonTool	none
position	UDim2	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.SelectRibbonTool from void to null
277 Add Plugin.SelectRibbonTool

Separate On DevHub

Parameters	1

Name	Type	Default
objects	Objects	none

Return Type	Objects
Security	PluginSecurity

History

190 Add Plugin.Separate

SetItem On DevHub

Parameters	2

Name	Type	Default
key	string	none
value	Variant	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.SetItem from void to null
433 Change Security of Plugin.SetItem from PluginSecurity to RobloxScriptSecurity
421 Change Security of Plugin.SetItem from RobloxScriptSecurity to PluginSecurity
408 Change Parameters of Plugin.SetItem from (string key, string value = ) to (string key, Variant value)
407 Change Security of Plugin.SetItem from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.SetItem from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.SetItem

SetReady On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.SetReady from void to null
493 Add Plugin.SetReady

SetSetting On DevHub

Parameters	2

Name	Type	Default
key	string	none
value	Variant	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.SetSetting from void to null
151 Change Security of Plugin.SetSetting from security1 to PluginSecurity
150 Change Security of Plugin.SetSetting from LocalUserSecurity to security1
128 Add Plugin.SetSetting

StartDecalDrag On DevHub

Parameters	1

Name	Type	Default
decal	Instance	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.StartDecalDrag from void to null
355 Add Plugin.StartDecalDrag

StartDrag On DevHub

Parameters	1

Name	Type	Default
dragData	Dictionary	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Plugin.StartDrag from void to null
366 Change Parameters of Plugin.StartDrag from (PluginDrag drag) to (Dictionary dragData)
366 Change Security of Plugin.StartDrag from RobloxScriptSecurity to PluginSecurity
354 Add Plugin.StartDrag

StopAllSounds On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Plugin.StopAllSounds from void to null
345 Add Plugin.StopAllSounds

Union On DevHub

Parameters	1

Name	Type	Default
objects	Objects	none

Return Type	Instance
Security	PluginSecurity

History

190 Add Plugin.Union

Unloading On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	PluginSecurity

History

370 Add Plugin.Unloading

UsesAssetInsertionDrag On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	RobloxScriptSecurity
Category	Behavior
Can Load	false
Can Save	false

History

469 Change CanLoad of Plugin.UsesAssetInsertionDrag from true to false
469 Change Tags of Plugin.UsesAssetInsertionDrag from [NotReplicated] to [Hidden, NotReplicated]
354 Add Plugin.UsesAssetInsertionDrag

Tags: [Hidden, NotReplicated]

Removed members

Bind

Parameters	2

Name	Type	Default
key	string	none
callback	Function	none

Return Type	Instance
Security	RobloxScriptSecurity

History

408 Remove Plugin.Bind
407 Change Security of Plugin.Bind from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.Bind from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.Bind

BindAndFire

Parameters	2

Name	Type	Default
key	string	none
callback	Function	none

Return Type	Instance
Security	RobloxScriptSecurity

History

408 Remove Plugin.BindAndFire
407 Change Security of Plugin.BindAndFire from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.BindAndFire from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.BindAndFire

CreatePluginGui

Parameters	3

Name	Type	Default
pluginGuiName	string	none
restoreEnabledState	bool	none
initialEnabledState	bool	none

Return Type	Instance
Security	PluginSecurity

History

326 Remove Plugin.CreatePluginGui
323 Change Parameters of Plugin.CreatePluginGui from (string pluginGuiId) to (string pluginGuiName, bool restoreEnabledState, bool initialEnabledState)
319 Add Plugin.CreatePluginGui

Fire

Parameters	2

Name	Type	Default
key	string	none
value	string

Return Type	void
Security	RobloxScriptSecurity

History

408 Remove Plugin.Fire
407 Change Security of Plugin.Fire from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.Fire from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.Fire

HasItem

Parameters	1

Name	Type	Default
key	string	none

Return Type	bool
Security	RobloxScriptSecurity

History

408 Remove Plugin.HasItem
407 Change Security of Plugin.HasItem from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.HasItem from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.HasItem

MDIInstance

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	MDIInstance
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

408 Remove Plugin.MDIInstance
407 Change ReadSecurity of Plugin.MDIInstance from PluginSecurity to RobloxScriptSecurity
407 Change WriteSecurity of Plugin.MDIInstance from PluginSecurity to RobloxScriptSecurity
399 Add Plugin.MDIInstance

Tags: [ReadOnly, NotReplicated]

RemoveItem

Parameters	1

Name	Type	Default
key	string	none

Return Type	bool
Security	RobloxScriptSecurity

History

408 Remove Plugin.RemoveItem
407 Change Security of Plugin.RemoveItem from PluginSecurity to RobloxScriptSecurity
400 Change Security of Plugin.RemoveItem from RobloxScriptSecurity to PluginSecurity
398 Add Plugin.RemoveItem

Relevant classes (9)

Relevant enums (3)

Relevant members (1)

CommandService.RegisterCommand (plugin)