PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

Plugin

Show deprecated

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.

Functions

void

Activate ( bool exclusiveMouse )

Sets the state of the calling plugin to activated

Instance

CreateDockWidgetPluginGui ( string pluginGuiId , DockWidgetPluginGuiInfo dockWidgetPluginGuiInfo )

[Yields]

This function creates a DockWidgetPluginGui using the provided DataType/DockWidgetPluginGuiInfo

Instance

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

Instance

CreatePluginMenu ( string id , string title , string icon )

Creates a new plugin menu

Instance

CreateToolbar ( string name )

Gets or creates a new Toolbar with the specified name, which is then used to create a plugin button.

void

Deactivate ( )

Deactivates the plugin

JointCreationMode

GetJoinMode ( )

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

Instance

GetMouse ( )

Returns a mouse that can be used with the plugin.

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 ( )

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.

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.

void

OpenScript ( Instance 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.

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

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

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

StartDrag ( Dictionary dragData )

Instance

Union ( Objects objects )

Unions the given parts and returns the resulting UnionOperation.

Events

RBXScriptSignal

Deactivation ( )

Fired when the plugin is deactivated

RBXScriptSignal

Unloading ( )

Fires immediately before the Plugin is unloaded or reloaded via uninstallation, Plugin/Deactivate|deactivation, or updating