We use cookies on this site to enhance your user experience

Plugin

Plugin

Plugin is the main object responsible for creating basic studio widgets.


Properties

Name Type Description
bool

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

float

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

Inherited from Instance

Archivable ClassName DataCost Name Parent RobloxLocked

Functions

Name Type Description
void

Sets the state of the calling plugin to activated. Allows mouse control through the Plugin/GetMouse method.

Instance

Creates a Dock-Widget PluginGui.

Instance

Creates a PluginAction.

Instance

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

void

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

JointCreationMode

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

Instance

Returns a mouse that can be used with the plugin.

RibbonTool

Returns the currently selected Enum/RibbonTool.

Variant

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

int64

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

void

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

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

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

bool

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.

Objects

Negates the given parts and returns the resulting NegateOperations.

void

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

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

void

Pauses a sound that was played via Plugin/PlaySound.

void

Starts playing a sound while the game isn’t running.

int64

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

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

void

Resumes a sound that was previously being played (via Plugin/PlaySound).

void

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

void

Activates the specified Roblox Studio tool.

Objects

Separates the given UnionOperations and returns the resulting parts.

void

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

void

Forces all sounds that are being played by the plugin to stop playing.

Instance

Unions the given parts and returns the resulting UnionOperation.

Inherited from Instance

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild

Events

Name Type Description

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.

Inherited from Instance

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving