Roblox API Reference

Plugin On DevHub

Summary

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

Tags: [NotCreatable]

Inherits (1)

Member index (47)

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
void Activate (bool exclusiveMouse) 71 150 151
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
void Deactivate () 330
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
void Invoke (string key, Tuple arguments) 408 421 433
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
void OpenScript (LuaSourceContainer script, int lineNumber = 1) 144 150 151 301 492
void OpenWikiPage (string url) 213
void PauseSound (Instance sound) 345 460
void PlaySound (Instance sound, double normalizedTimePosition = 0) 345 449 460
int64 PromptForExistingAssetId (string assetType) 220 224 224 322
bool PromptSaveSelection (string suggestedFileName = ) 268
void ResumeSound (Instance sound) 345 460
void SaveSelectedToRoblox () 128 150 151
void SelectRibbonTool (RibbonTool tool, UDim2 position) 277
Objects Separate (Objects objects) 190
void SetItem (string key, Variant value) 398 400 407 408 421 433
void SetReady () 493
void SetSetting (string key, Variant value) 128 150 151
void StartDecalDrag (Instance decal) 355
void StartDrag (Dictionary dragData) 354 366 366
void StopAllSounds () 345
Instance Union (Objects objects) 190
Deactivation () 150 151
Ready () 493
Unloading () 370
51 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

History

Members

Activate On DevHub

Name Type Default
exclusiveMouse bool none

History

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.

History

Tags: [ReadOnly, NotReplicated]

CreateDockWidgetPluginGui On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
pluginGuiId string none
dockWidgetPluginGuiInfo DockWidgetPluginGuiInfo none

History

Tags: [Yields]

CreatePluginAction On DevHub

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

History

CreatePluginMenu On DevHub

Name Type Default
id string none
title string
icon string

History

CreateQWidgetPluginGui On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
pluginGuiId string none
pluginGuiOptions Dictionary none

History

Tags: [Yields]

CreateToolbar On DevHub

Name Type Default
name string none

History

Deactivate On DevHub

Name Type Default
No parameters.

History

Deactivation On DevHub

Name Type Default
No parameters.

History

GetItem On DevHub

Name Type Default
key string none
defaultValue Variant none

History

GetJoinMode On DevHub

Name Type Default
No parameters.

History

GetMouse On DevHub

Name Type Default
No parameters.

History

GetSelectedRibbonTool On DevHub

Name Type Default
No parameters.

History

GetSetting On DevHub

Name Type Default
key string none

History

GetStudioUserId On DevHub

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

History

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.

History

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.

History

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.

History

Tags: [Hidden, ReadOnly, NotReplicated]

ImportFbxAnimation On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
rigModel Instance none
isR15 bool true

History

Tags: [Yields]

ImportFbxRig On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
isR15 bool true

History

Tags: [Yields]

Invoke On DevHub

Name Type Default
key string none
arguments Tuple none

History

IsActivated On DevHub

Name Type Default
No parameters.

History

IsActivatedWithExclusiveMouse On DevHub

Name Type Default
No parameters.

History

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.

History

Tags: [Hidden, ReadOnly, NotReplicated]

Negate On DevHub

Name Type Default
objects Objects none

History

OnInvoke On DevHub

Name Type Default
key string none
callback Function none

History

OnSetItem On DevHub

Name Type Default
key string none
callback Function none

History

OpenScript On DevHub

Name Type Default
script LuaSourceContainer none
lineNumber int 1

History

OpenWikiPage On DevHub

Name Type Default
url string none

History

PauseSound On DevHub

Name Type Default
sound Instance none

History

PlaySound On DevHub

Name Type Default
sound Instance none
normalizedTimePosition double 0

History

PromptForExistingAssetId On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
assetType string none

History

Tags: [Yields]

PromptSaveSelection On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
suggestedFileName string

History

Tags: [Yields]

Ready On DevHub

Name Type Default
No parameters.

History

ResumeSound On DevHub

Name Type Default
sound Instance none

History

SaveSelectedToRoblox On DevHub

Name Type Default
No parameters.

History

SelectRibbonTool On DevHub

Name Type Default
tool RibbonTool none
position UDim2 none

History

Separate On DevHub

Name Type Default
objects Objects none

History

SetItem On DevHub

Name Type Default
key string none
value Variant none

History

SetReady On DevHub

Name Type Default
No parameters.

History

SetSetting On DevHub

Name Type Default
key string none
value Variant none

History

StartDecalDrag On DevHub

Name Type Default
decal Instance none

History

StartDrag On DevHub

Name Type Default
dragData Dictionary none

History

StopAllSounds On DevHub

Name Type Default
No parameters.

History

Union On DevHub

Name Type Default
objects Objects none

History

Unloading On DevHub

Name Type Default
No parameters.

History

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.

History

Tags: [Hidden, NotReplicated]

Removed members

Bind

Name Type Default
key string none
callback Function none

History

BindAndFire

Name Type Default
key string none
callback Function none

History

CreatePluginGui

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

History

Fire

Name Type Default
key string none
value string

History

HasItem

Name Type Default
key string none

History

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.

History

Tags: [ReadOnly, NotReplicated]

RemoveItem

Name Type Default
key string none

History

Relevant classes (9)

Relevant enums (3)

Relevant members (1)