Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Plugin

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable]

Member index 52

HistoryMember
553CollisionEnabled: bool
553GridSize: float
573Activate(exclusiveMouse: bool): null
483CreateDockWidgetPluginGui(pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui
483CreatePluginAction(actionId: string, text: string, statusTip: string, iconName: string = , allowBinding: bool = true): PluginAction
483CreatePluginMenu(id: string, title: string = , icon: string = ): PluginMenu
483CreateQWidgetPluginGui(pluginGuiId: string, pluginGuiOptions: Dictionary): QWidgetPluginGui
483CreateToolbar(name: string): PluginToolbar
573Deactivate(): null
462GetItem(key: string, defaultValue: Variant): Variant
462GetJoinMode(): JointCreationMode
483GetMouse(): PluginMouse
619GetPluginComponent(name: string): Dictionary
462GetSelectedRibbonTool(): RibbonTool
462GetSetting(key: string): Variant
462GetStudioUserId(): int64
623GetUri(): Dictionary
462ImportFbxAnimation(rigModel: Instance, isR15: bool = true): Instance
462ImportFbxRig(isR15: bool = true): Instance
568Intersect(objects: Objects): Instance
573Invoke(key: string, arguments: Tuple): null
462IsActivated(): bool
462IsActivatedWithExclusiveMouse(): bool
462Negate(objects: Objects): Objects
462OnInvoke(key: string, callback: Function): Instance
462OnSetItem(key: string, callback: Function): Instance
573OpenScript(script: LuaSourceContainer, lineNumber: int = 1): null
573OpenWikiPage(url: string): null
573PauseSound(sound: Instance): null
573PlaySound(sound: Instance, normalizedTimePosition: double = 0): null
462PromptForExistingAssetId(assetType: string): int64
462PromptSaveSelection(suggestedFileName: string = ): bool
573ResumeSound(sound: Instance): null
573SaveSelectedToRoblox(): null
573SelectRibbonTool(tool: RibbonTool, position: UDim2): null
462Separate(objects: Objects): Objects
573SetItem(key: string, value: Variant): null
573SetReady(): null
573SetSetting(key: string, value: Variant): null
573StartDecalDrag(decal: Instance): null
573StartDrag(dragData: Dictionary): null
573StopAllSounds(): null
462Union(objects: Objects): Instance
462Deactivation()
493Ready()
462Unloading()
532ProcessAssetInsertionDrag(assetId: string, assetTypeId: int, instances: Objects): Objects
573ProcessAssetInsertionDrop(): null
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 7

HistoryMember
408MDIInstance: MDIInstance
408Bind(key: string, callback: Function): Instance
408BindAndFire(key: string, callback: Function): Instance
326CreatePluginGui(pluginGuiName: string, restoreEnabledState: bool, initialEnabledState: bool): Instance
408Fire(key: string, value: string = ): void
408HasItem(key: string): bool
408RemoveItem(key: string): bool

History 249

Members 52

Activate

Parameters (1)
exclusiveMousebool
Returns (1)
null

History 6

CollisionEnabled

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

CreateDockWidgetPluginGui

Parameters (2)
pluginGuiIdstring
dockWidgetPluginGuiInfoDockWidgetPluginGuiInfo
Returns (1)
DockWidgetPluginGui
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

CreatePluginAction

Parameters (5)Default
actionIdstring
textstring
statusTipstring
iconNamestring
allowBindingbooltrue
Returns (1)
PluginAction

History 5

CreatePluginMenu

Parameters (3)Default
idstring
titlestring
iconstring
Returns (1)
PluginMenu

History 3

CreateQWidgetPluginGui

Parameters (2)
pluginGuiIdstring
pluginGuiOptionsDictionary
Returns (1)
QWidgetPluginGui
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

CreateToolbar

Parameters (1)
namestring
Returns (1)
PluginToolbar

History 5

Deactivate

Parameters (0)
No parameters.
Returns (1)
null

History 3

Deactivation

Parameters (0)
No parameters.

History 4

GetItem

Parameters (2)
keystring
defaultValueVariant
Returns (1)
Variant

History 8

GetJoinMode

Parameters (0)
No parameters.
Returns (1)
JointCreationMode

History 2

GetMouse

Parameters (0)
No parameters.
Returns (1)
PluginMouse

History 5

GetPluginComponent

Parameters (1)
namestring
Returns (1)
Dictionary
This function has a custom internal state. It may behave in a non-standard way.

History 1

Tags: [CustomLuaState]

GetSelectedRibbonTool

Parameters (0)
No parameters.
Returns (1)
RibbonTool

History 2

GetSetting

Parameters (1)
keystring
Returns (1)
Variant

History 4

GetStudioUserId

Parameters (0)
No parameters.
Returns (1)
int64
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

GetUri

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 1

GridSize

TypeDefault
float
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

ImportFbxAnimation

Parameters (2)Default
rigModelInstance
isR15booltrue
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

ImportFbxRig

Parameters (1)Default
isR15booltrue
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 9

Tags: [Yields]

Intersect

Parameters (1)
objectsObjects
Returns (1)
Instance

History 1

Invoke

Parameters (2)
keystring
argumentsTuple
Returns (1)
null

History 5

IsActivated

Parameters (0)
No parameters.
Returns (1)
bool

History 2

IsActivatedWithExclusiveMouse

Parameters (0)
No parameters.
Returns (1)
bool

History 2

Negate

Parameters (1)
objectsObjects
Returns (1)
Objects

History 2

OnInvoke

Parameters (2)
keystring
callbackFunction
Returns (1)
Instance

History 4

OnSetItem

Parameters (2)
keystring
callbackFunction
Returns (1)
Instance

History 4

OpenScript

Parameters (2)Default
scriptLuaSourceContainer
lineNumberint1
Returns (1)
null

History 7

OpenWikiPage

Parameters (1)
urlstring
Returns (1)
null

History 3

PauseSound

Parameters (1)
soundInstance
Returns (1)
null

History 4

PlaySound

Parameters (2)Default
soundInstance
normalizedTimePositiondouble0
Returns (1)
null

History 5

ProcessAssetInsertionDrag

Parameters (3)
assetIdstring
assetTypeIdint
instancesObjects
Returns (1)
Objects

History 1

Tags: [NoYield]

ProcessAssetInsertionDrop

Parameters (0)
No parameters.
Returns (1)
null

History 2

Tags: [NoYield]

PromptForExistingAssetId

Parameters (1)
assetTypestring
Returns (1)
int64
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

PromptSaveSelection

Parameters (1)Default
suggestedFileNamestring
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Ready

Parameters (0)
No parameters.

History 1

ResumeSound

Parameters (1)
soundInstance
Returns (1)
null

History 4

SaveSelectedToRoblox

Parameters (0)
No parameters.
Returns (1)
null

History 5

SelectRibbonTool

Parameters (2)
toolRibbonTool
positionUDim2
Returns (1)
null

History 3

Separate

Parameters (1)
objectsObjects
Returns (1)
Objects

History 2

SetItem

Parameters (2)
keystring
valueVariant
Returns (1)
null

History 8

SetReady

Parameters (0)
No parameters.
Returns (1)
null

History 2

SetSetting

Parameters (2)
keystring
valueVariant
Returns (1)
null

History 5

StartDecalDrag

Parameters (1)
decalInstance
Returns (1)
null

History 3

StartDrag

Parameters (1)
dragDataDictionary
Returns (1)
null

History 5

StopAllSounds

Parameters (0)
No parameters.
Returns (1)
null

History 3

Union

Parameters (1)
objectsObjects
Returns (1)
Instance

History 2

Unloading

Parameters (0)
No parameters.

History 2

Removed members 7

Bind

Parameters (2)
keystring
callbackFunction
Returns (1)
Instance

History 4

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

BindAndFire

Parameters (2)
keystring
callbackFunction
Returns (1)
Instance

History 4

CreatePluginGui

Parameters (3)
pluginGuiNamestring
restoreEnabledStatebool
initialEnabledStatebool
Returns (1)
Instance

History 3

Fire

Parameters (2)Default
keystring
valuestring
Returns (1)
void

History 4

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

HasItem

Parameters (1)
keystring
Returns (1)
bool

History 4

MDIInstance

TypeDefault
MDIInstance
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

RemoveItem

Parameters (1)
keystring
Returns (1)
bool

History 4

Settings