Plugin

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

Returns the grid size the user has set in studio under the Model tab. This can be 1, 0.2 or 0.01, but has rounding errors. The 1/5th option should return 0.2, but could return 0.20000000298023 instead. This code can be used to get the real gridsize:

1local gridsize = plugin.GridSize
2if math.abs(gridsize-0.2) < 0.005 then -- Check if the gridsize is between 0.195 and 0.205
3	gridsize = 0.2
4elseif math.abs(gridsize-0.01) < 0.005 then -- Between 0.005 and 0.015
5	gridsize = 0.01
6else -- Assume it's 1
7	gridsize = 1
8end
9

Fired when the Plugin is deactivated. This occurs when either the plugin code calls Plugin:Deactivate(), or because some other plugin called Plugin:Activate(), which forces all other plugins to lose their active state.

See also:

• Plugin.Unloading, fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating

This event fires immediately before the Plugin stops running. Plugins are unloaded when disabled, uninstalled, about to be updated, or when the place is closing.

It enables a plugin to clean up after itself before its scripts stop running, e.g. to remove unnecessary instances from the DataModel. If a plugin does not clean up properly, the old copies will remain. When this occurs, users may be forced to close and reopen the place which is a bad user experience.

Plugin-related instances such as PluginToolbarButtons, DockWidgetPluginGuis, and PluginGuis are automatically cleaned up when the plugin is unloaded so there is no need to remove them.

This function sets the state of the calling plugin to activated. Activating the plugin allows mouse control through the Plugin:GetMouse() method.

At any given time there are either 0 or 1 Activated Plugins. Activating a plugin will deactivate all other plugins (they will receive a Plugin.Deactivation event).

See also:

• Plugin:IsActivatedWithExclusiveMouse(), returns true if this plugin is currently active with an exclusive mouse, after having been activated via this function
• Plugin.Unloading, fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating

This function creates a PluginAction which is an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button. In Roblox Studio, they can be assigned a keyboard shortcut under File → Advanced → Customize Shortcuts…, and they can also be added to the Quick Access Toolbar.

When an action is triggered, the PluginAction.Triggered event is signaled.

In order for PluginActions work as expected, they must be created using this function.

See also:

• PluginMenu, a context menu that can be shown in Studio which displays a list of PluginActions and supports submenus
• Plugin:CreatePluginMenu(), creates a PluginMenu

This function creates a new PluginMenu, which is a context menu that can be shown in Studio that displays a list of PluginActions and supports submenus.

In order for PluginMenus to work as expected, they must be created using this function.

See also:

• PluginAction, an object that represents a generic performable action in Roblox Studio, with no directly associated Toolbar or Button.
• Plugin:CreatePluginAction(), creates a PluginAction
• PluginMenu.Title, the text to be displayed when used as a sub menu
• PluginMenu.Icon, the icon to be displayed when used as a sub menu
• PluginMenu:AddAction(), adds the given action to the menu
• PluginMenu:AddNewAction(), creates a temporary action that is hidden from Studio's customize shortcuts window
• PluginMenu:AddMenu(), adds the given menu as a separator
• PluginMenu:AddSeparator(), adds a separator between items in the menu
• PluginMenu:Clear(), clears the menu
• PluginMenu:ShowAsync(), shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event

The CreateToolbar function creates a new PluginToolbar with the given name. The toolbar can then be used to create plugin buttons.

Deactivates the plugin. This will disengage the associated PluginMouse if it has been activated

See also:

• Plugin:Activate(), sets the state of the calling plugin to activated
• Plugin.Deactivation, fires when the plugin is deactivated
• Plugin.Unloading, fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating

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

GetMouse returns a PluginMouse that can be used while the plugin is active through Plugin:Activate().

GetSelectedRibbonTool return the currently selected RibbonTool. It returns an Enum that corresponds to a particular tool. This will return whether the tool is selected manually or programmatically via Plugin:SelectRibbonTool().

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

This function returns true if this plugin is currently active, after having been activated via the Plugin:Activate() function.

This function returns true if this plugin is currently active with an exclusive mouse, after having been activated via the Plugin:Activate() function. If this returns true, a PluginMouse can be retrieved via Plugin:GetMouse().

See also:

• Plugin.Deactivation, fires when the plugin is deactivated
• Plugin.Unloading, fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating

Negates the given parts and returns the resulting NegateOperations.

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.

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

Opens an upload window for the user's current selection.

Activates the specified Roblox Studio tool. If the tool opens a window, the position parameter specifies where it should be shown on the screen.

Note:

• An object must be selected in order for this to work correctly.
• Altering the scale fields of the position property will not affect the dialog popups.

Separates the given UnionOperations and returns the resulting parts.

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

StartDrag initiates a drag action using a dictionary of parameters. The parameters are as follows:

See also:

• PluginGui.PluginDragEntered
• PluginGui.PluginDragMoved
• PluginGui.PluginDragDropped
• PluginGui.PluginDragLeft

Unions the given parts and returns the resulting UnionOperation.

CreateDockWidgetPluginGui creates a new DockWidgetPluginGui from the given DockWidgetPluginGuiInfo. The first parameter, pluginGuiId, should be a unique and consistent string. It is used to save the state of the widget's dock state and other internal details.

This function 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.

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.

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.

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