Plugin

The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.

Memory category: Instances
Own members: 66
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties31

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byPlugin8

Property categoryBehavior

Plugin.UsesAssetInsertionDrag: boolean
- Hidden
- Not replicated
- Roblox script security

Property categoryData

Plugin.CollisionEnabled: boolean
Returns whether the user has enabled Collisions in Studio's toolbar.
- Read only
Plugin.DisableUIDragDetectorDrags: boolean
If true, toolbars and buttons for the plugin will ignore dragging related to a UIDragDetector instance.
- Roblox script security
Plugin.GridSize: number
Returns the grid snapping size the user has set in Studio.
- Read only
Plugin.HostDataModelType: Enum.StudioDataModelType
- Hidden
- Read only
- Roblox script security
Plugin.HostDataModelTypeIsCurrent: boolean
- Hidden
- Read only
- Roblox script security
Plugin.IsDebuggable: boolean
Indicates whether the plugin's scripts can be debugged in Studio.
- Roblox script security
Plugin.MultipleDocumentInterfaceInstance: MultipleDocumentInterfaceInstance
- Hidden
- Read only
- Roblox script security

Methods92

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byPlugin50

Plugin:Activate(exclusiveMouse: boolean)
Sets the state of the calling plugin to activated.
- Plugin security
Parameters
Parameter Description
exclusiveMouse: boolean
A boolean specifying whether to activate the plugin with exclusive mouse. If true, a PluginMouse can be retrieved via GetMouse().

Plugin:CreateDockWidgetPluginGuiAsync(pluginGuiId: string,dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo,): DockWidgetPluginGui

Creates a DockWidgetPluginGui given a DockWidgetPluginGuiInfo.

Parameters
Parameter	Description
`pluginGuiId: string`	A unique and consistent identifier used to storing the widget's dock state and other internal details.
`dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo`	Describes the `DockWidgetPluginGui` to create (initial state, size, etc).

Returns
Type
`DockWidgetPluginGui`

Plugin:CreatePluginAction(actionId: string,text: string,statusTip: string,iconName: string? = "",allowBinding: boolean? = true,): PluginAction

Creates a PluginAction which represents a generic performable action in Studio with no directly‑associated PluginToolbarButton.

Parameters
Parameter	Description
`actionId: string`	Must be a unique string that identifies this PluginAction from others.
`text: string`	The displayed name of the action.
`statusTip: string`	The displayed description of the action.
`iconName: string? = ""`	The name of the icon used to display the plugin.
`allowBinding: boolean? = true`	Whether the `PluginAction` will be hidden from Studio's shortcuts view. Useful for contextual actions. Defaults to true.

Returns
Type
`PluginAction`

Plugin:CreatePluginMenu(id: string,title: string? = "",icon: string? = "",): PluginMenu
Creates a new plugin menu.
- Plugin security
Parameters
Parameter Description
id: string
Unique ID for the menu.
title: string? = ""
The text to be displayed when used as a submenu.
icon: string? = ""
The icon to be displayed when used as a submenu.
Returns
Type
PluginMenu
Plugin:CreateQWidgetPluginGui(pluginGuiId: string,pluginGuiOptions: { [string]: any },): QWidgetPluginGui
- Yields
- Roblox script security
Parameters
Parameter
pluginGuiId: string
pluginGuiOptions: { [string]: any }
Returns
Type
QWidgetPluginGui
Plugin:CreateToolbar(name: string): PluginToolbar
Creates a new PluginToolbar with the given name.
- Plugin security
Parameters
Parameter Description
name: string
The visible text on the toolbar, labeling the group of buttons contained within.
Returns
Type
PluginToolbar
Plugin:Deactivate()
Deactivates the plugin.
- Plugin security
Plugin:FinishFullLoading(payload: any)
- Custom Lua state
- Roblox script security
Parameters
Parameter
payload: any
Plugin:GetItem(key: string, defaultValue: any): any
- Roblox script security
Parameters
Parameter
key: string
defaultValue: any
Returns
Type
any
Plugin:GetJoinMode(): Enum.JointCreationMode
Returns the JointCreationMode the user has set in Studio's toolbar.
- Plugin security
Returns
Type
Enum.JointCreationMode
Plugin:GetMouse(): PluginMouse
Returns a Mouse that can be used while the plugin is active.
- Plugin security
Returns
Type
PluginMouse
Plugin:GetPluginComponent(name: string): any
- Custom Lua state
- Roblox script security
Parameters
Parameter
name: string
Returns
Type
any
Plugin:GetPreinitPayload(): any
- Custom Lua state
- Roblox script security
Returns
Type
any
Plugin:GetSelectedRibbonTool(): Enum.RibbonTool
Returns the currently selected RibbonTool.
- Plugin security
Returns
Type
Enum.RibbonTool
Plugin:GetSetting(key: string): any
Retrieves a previously stored value with the given key, or nil if the given key doesn't exist.
- Plugin security
Parameters
Parameter Description
key: string
The string key that was previously passed to SetSetting().
Returns
Type
any
Plugin:GetUri(): { [string]: any }
- Roblox script security
Returns
Type
{ [string]: any }

Plugin:ImportFbxAnimationAsync(rigModel: Instance,isR15: boolean? = true,): Instance

Prompts the user to open a .fbx animation file that can be loaded onto the rigModel, then proceeds to insert the animation as a KeyframeSequence in the Workspace.

Parameters
Parameter	Description
`rigModel: Instance`	The rig model that the imported animation will be applied to.
`isR15: boolean? = true`	Whether the animation file should be interpreted as an R15 rig. Defaults to `true`.

Returns
Type
`Instance`

Plugin:ImportFbxRigAsync(isR15: boolean? = true): Instance
Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the Workspace.
- Yields
- Plugin security
Parameters
Parameter Description
isR15: boolean? = true
Whether the rig file should be interpreted as R15. Defaults to true.
Returns
Type
Instance
Plugin:Intersect(objects: { Instance }): Instance
Intersects the given parts and returns the resulting IntersectOperation.
- Plugin security
Parameters
Parameter Description
objects: { Instance }
The array of BaseParts to intersect.
Returns
Type
Instance
Plugin:Invoke(key: string, ...: any)
- Roblox script security
Parameters
Parameter
key: string
...: any
Plugin:IsActivated(): boolean
Returns true if this plugin is currently active, after having been activated via the Activate() function.
- Plugin security
Returns
Type Description
boolean
A boolean indicating whether the plugin is currently active.
Plugin:IsActivatedWithExclusiveMouse(): boolean
Returns true if this plugin is currently active with an exclusive mouse.
- Plugin security
Returns
Type Description
boolean
Whether this plugin is currently active with an exclusive mouse.
Plugin:IsLoadedFromProject(): boolean
- Roblox script security
Returns
Type
boolean
Plugin:Negate(objects: { Instance }): { Instance }
Negates the given parts and returns the resulting NegateOperations.
- Plugin security
Parameters
Parameter Description
objects: { Instance }
The array of BaseParts to negate.
Returns
Type
{ Instance }
Plugin:OnInvoke(key: string, callback: (...any) -> ...any): Instance
- Roblox script security
Parameters
Parameter
key: string
callback: (...any) -> ...any
Returns
Type
Instance
Plugin:OnInvokeSuspendOverride(key: string,callback: (...any) -> ...any,): Instance
- Roblox script security
Parameters
Parameter
key: string
callback: (...any) -> ...any
Returns
Type
Instance
Plugin:OnSetItem(key: string, callback: (...any) -> ...any): Instance
- Roblox script security
Parameters
Parameter
key: string
callback: (...any) -> ...any
Returns
Type
Instance
Plugin:OpenWikiPage(url: string)
Opens the context help window to the wiki page that url links to.
- Plugin security
Parameters
Parameter Description
url: string
The URL of the wiki/documentation page to open.
Plugin:PauseSound(sound: Instance)
- Roblox script security
Parameters
Parameter
sound: Instance
Plugin:PlaySound(sound: Instance, normalizedTimePosition: number? = 0)
- Roblox script security
Parameters
Parameter
sound: Instance
normalizedTimePosition: number? = 0
Plugin:PromptForExistingAssetId(assetType: string): number
Opens a window in Roblox Studio that prompts the user to select an existing AssetType.Animation asset. The assetType parameter must be Animation; other values are not supported and cause an error.
- Yields
- Plugin security
Parameters
Parameter Description
assetType: string
The asset type to browse. Only Animation is supported.
Returns
Type
number
Plugin:PromptForExistingAssetIdAsync(assetType: string): number
Opens a window in Roblox Studio that prompts the user to select an existing AssetType.Animation asset. The assetType parameter must be Animation; other values are not supported and cause an error.
- Yields
- Plugin security
Parameters
Parameter Description
assetType: string
The asset type to browse. Only Animation is supported.
Returns
Type
number
Plugin:PromptSaveSelectionAsync(suggestedFileName: string? = ""): boolean
Prompts the user to save their current selection with the specified file name.
- Yields
- Plugin security
Parameters
Parameter Description
suggestedFileName: string? = ""
The default file name shown in the save dialog. Defaults to an empty string.
Returns
Type
boolean
Plugin:ResumeSound(sound: Instance)
- Roblox script security
Parameters
Parameter
sound: Instance
Plugin:SaveSelectedToRoblox()
Opens an upload window for the user's current selection.
- Plugin security
Plugin:SelectRibbonTool(tool: Enum.RibbonTool, position: UDim2)
Activates the specified Roblox Studio tool.
- Plugin security
Parameters
Parameter Description
tool: Enum.RibbonTool
The RibbonTool to activate.
position: UDim2
The UDim2 screen position at which to show the tool's dialog window, if applicable.
Plugin:Separate(objects: { Instance }): { Instance }
Separates the given UnionOperations and returns the resulting parts.
- Plugin security
Parameters
Parameter Description
objects: { Instance }
The array of UnionOperations to separate.
Returns
Type
{ Instance }
Plugin:SetItem(key: string, value: any)
- Roblox script security
Parameters
Parameter
key: string
value: any
Plugin:SetReady()
- Roblox script security
Plugin:SetSetting(key: string, value: any)
Stores a given value for later use under the given key. The value will persist even after Studio is closed.
- Plugin security
Parameters
Parameter Description
key: string
The string key to store the value under.
value: any
The value to store. Must be JSON-serializable (string, number, boolean, table, or nil).
Plugin:StartDecalDrag(decal: Instance)
- Roblox script security
Parameters
Parameter
decal: Instance
Plugin:StartDrag(dragData: { [string]: any })
Starts a drag action given a dictionary of parameters.
- Plugin security
Parameters
Parameter Description
dragData: { [string]: any }
A dictionary describing the drag, including fields such as Sender, MimeType, Data, MouseIcon, DragIcon, and HotSpot.
Plugin:StopAllSounds()
- Roblox script security
Plugin:Union(objects: { Instance }): Instance
Unions the given parts and returns the resulting UnionOperation.
- Plugin security
Parameters
Parameter Description
objects: { Instance }
The array of BaseParts to union together.
Returns
Type
Instance

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

Deprecated: This method has been superseded by CreateDockWidgetPluginGuiAsync().
Creates a DockWidgetPluginGui given a DockWidgetPluginGuiInfo.

Parameters
Parameter	Description
`pluginGuiId: string`	A unique and consistent identifier used to storing the widget's dock state and other internal details.
`dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo`	Describes the `DockWidgetPluginGui` to create (initial state, size, etc).

Returns
Type
`DockWidgetPluginGui`

Use CreateDockWidgetPluginGuiAsync instead.

Plugin:GetStudioUserId(): number
Deprecated:
Returns the Studio user's userId if they're logged in, otherwise returns 0.
- Deprecated
- Plugin security
Returns
Type
number

Plugin:ImportFbxAnimation(rigModel: Instance, isR15: boolean? = true): Instance

Deprecated:
Prompts the user to open a .fbx animation file that can be loaded onto the rigModel, then proceeds to insert the animation as a KeyframeSequence in the Workspace.

Parameters
Parameter	Description
`rigModel: Instance`	The rig model that the imported animation will be applied to.
`isR15: boolean? = true`	Whether the animation file should be interpreted as an R15 rig. Defaults to `true`.

Returns
Type
`Instance`

Use ImportFbxAnimationAsync instead.

Plugin:ImportFbxRig(isR15: boolean? = true): Instance
Deprecated: This method has been superseded by ImportFbxRigAsync().
Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the Workspace.
- Deprecated
- Yields
- Plugin security
Parameters
Parameter Description
isR15: boolean? = true
Whether the rig file should be interpreted as R15. Defaults to true.
Returns
Type
Instance
Use ImportFbxRigAsync instead.
Plugin:OpenScript(script: LuaSourceContainer, lineNumber: number? = 1)
Deprecated:
Used to open the given script instance in an editor window, in Roblox studio, at the given line. If no line is given as an argument it will default to 1.
- Deprecated
- Plugin security
Parameters
Parameter Description
script: LuaSourceContainer
The LuaSourceContainer script instance to open.
lineNumber: number? = 1
The line number to navigate to in the editor. Defaults to 1.
Plugin:PromptSaveSelection(suggestedFileName: string? = ""): boolean
Deprecated: This method has been superseded by PromptSaveSelectionAsync().
Prompts the user to save their current selection with the specified file name.
- Deprecated
- Yields
- Plugin security
Parameters
Parameter Description
suggestedFileName: string? = ""
The default file name shown in the save dialog. Defaults to an empty string.
Returns
Type
boolean
Use PromptSaveSelectionAsync instead.

Events16

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byPlugin6

Plugin.Deactivation: RBXScriptSignal<()>
Fired when the plugin is deactivated.
- Plugin security
Plugin.Ready: RBXScriptSignal<()>
- Roblox script security
Plugin.Unloading: RBXScriptSignal<()>
Fires immediately before the Plugin stops running.
- Plugin security
Plugin.ViewportDragDropped: RBXScriptSignal<(dragData: { [string]: any })>
- Roblox script security
Parameters
Parameter
dragData: { [string]: any }
Plugin.ViewportDragEntered: RBXScriptSignal<(dragData: { [string]: any })>
- Roblox script security
Parameters
Parameter
dragData: { [string]: any }
Plugin.ViewportDragLeft: RBXScriptSignal<()>
- Roblox script security

Callbacks2

Defined byPlugin2

Plugin.ProcessAssetInsertionDrag: (assetId: string,assetTypeId: number,instances: { Instance },) -> { Instance }
- No yield
- Roblox script security
Parameters
Parameter
assetId: string
assetTypeId: number
instances: { Instance }
Returns
Type
{ Instance }
Plugin.ProcessAssetInsertionDrop: () -> ()
- No yield
- Roblox script security