PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. Plugin

Plugin

Show deprecated
Hide content
  1. apireference
  2. plugin

Plugin

Show deprecated

Plugin is the main object responsible for creating basic studio widgets. It is a custom add-on to Studio which adds new behavior and features that are not normally included.

Both the articles/using animation editor|Animation Editor and articles/Intro To Terrain|Terrain Tools were originally developed as plugins. There are also many plugins made by the Roblox community that you can use to help make games and experiences.

See also

articles/Intro to Plugins, an introductory article to plugin use and development

Properties

bool

CollisionEnabled

[ReadOnly] [NotReplicated]

Returns whether the user enabled Collisions in studio under the Model tab.
float

GridSize

[ReadOnly] [NotReplicated]

Returns the grid size the user has set in studio under the Model tab.
StudioDataModelType

HostDataModelType

[Hidden] [ReadOnly] [NotReplicated]
bool

HostDataModelTypeIsCurrent

[Hidden] [ReadOnly] [NotReplicated]
MultipleDocumentInterfaceInstance

MultipleDocumentInterfaceInstance

[Hidden] [ReadOnly] [NotReplicated]
bool

UsesAssetInsertionDrag

[Hidden] [NotReplicated]

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

Activate ( bool exclusiveMouse )

Sets the state of the calling plugin to activated
DockWidgetPluginGui

CreateDockWidgetPluginGui ( string pluginGuiId , DockWidgetPluginGuiInfo dockWidgetPluginGuiInfo )

[Yields]

Creates a DockWidgetPluginGui given a DataType/DockWidgetPluginGuiInfo
PluginAction

CreatePluginAction ( string actionId , string text , string statusTip , string iconName , bool allowBinding )

Creates a PluginAction which is an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button
PluginMenu

CreatePluginMenu ( string id , string title , string icon )

Creates a new plugin menu
QWidgetPluginGui

CreateQWidgetPluginGui ( string pluginGuiId , Dictionary pluginGuiOptions )

[Yields]
PluginToolbar

CreateToolbar ( string name )

Creates a new PluginToolbar with the given name.
void

Deactivate ( )

Deactivates the plugin
Variant

GetItem ( string key , Variant defaultValue )

JointCreationMode

GetJoinMode ( )

Returns the Enum/JointCreationMode the user has set in studio under the Model tab.
PluginMouse

GetMouse ( )

Returns a Mouse that can be used while the plugin is active.
RibbonTool

GetSelectedRibbonTool ( )

Returns the currently selected Enum/RibbonTool.
Variant

GetSetting ( string key )

Retrieves a previously stored value with the given key, or nil if the given key doesn’t exist.
int64

GetStudioUserId ( )

[Deprecated]

Returns the studio user’s userId if they’re logged in, otherwise returns 0.
Instance

ImportFbxAnimation ( Instance rigModel , bool isR15 )

[Yields]

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
Instance

ImportFbxRig ( bool isR15 )

[Yields]

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.
void

Invoke ( string key , Tuple arguments )

bool

IsActivated ( )

Returns true if this plugin is currently active, after having been activated via the Plugin/Activate function
bool

IsActivatedWithExclusiveMouse ( )

Returns true if this plugin is currently active with an exclusive mouse, after having been activated via the Plugin/Activate function
Objects

Negate ( Objects objects )

Negates the given parts and returns the resulting NegateOperations.
Instance

OnInvoke ( string key , Function callback )

Instance

OnSetItem ( string key , Function callback )

void

OpenScript ( LuaSourceContainer script , int lineNumber )

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 0.
void

OpenWikiPage ( string url )

Opens the context help window to the wiki page that url links to.
void

PauseSound ( Instance sound )

void

PlaySound ( Instance sound , double normalizedTimePosition )

int64

PromptForExistingAssetId ( string assetType )

[Yields]

Opens a window in Roblox Studio, which prompts the user to select an asset based on the assetType specified. Returns what assetId was selected, or -1 if the window was closed.
bool

PromptSaveSelection ( string suggestedFileName )

[Yields]

Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
void

ResumeSound ( Instance sound )

void

SaveSelectedToRoblox ( )

Opens an upload window for the user’s current selection.
void

SelectRibbonTool ( RibbonTool tool , UDim2 position )

Activates the specified Roblox Studio tool.
Objects

Separate ( Objects objects )

Separates the given UnionOperations and returns the resulting parts.
void

SetItem ( string key , Variant value )

void

SetReady ( )

void

SetSetting ( string key , Variant value )

Stores a given value for later use under the given key. The value will persist even after studio is closed.
void

StartDecalDrag ( Instance decal )

void

StartDrag ( Dictionary dragData )

Starts a drag action given a dictionary of parameters
void

StopAllSounds ( )

Instance

Union ( Objects objects )

Unions the given parts and returns the resulting UnionOperation.

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

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.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

Deactivation ( )

Fired when the plugin is deactivated
RBXScriptSignal

Ready ( )

RBXScriptSignal

Unloading ( )

Fires immediately before the Plugin stops running

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]
MultipleDocumentInterfaceInstance PluginAction