# Plugin（ロブロックス クラス）

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

- URL：https://roblox.minecraft-okinawa.com/reference/classes/Plugin/
- 公式：https://create.roblox.com/docs/reference/engine/classes/Plugin
- 受け継いでいるクラス：Instance

## プロパティ

- `Plugin.CollisionEnabled: boolean`：Returns whether the user has enabled **Collisions** in Studio's toolbar.
- `Plugin.GridSize: float`：Returns the grid snapping size the user has set in Studio.

## メソッド

- `Plugin:Activate(exclusiveMouse: boolean): ()`：Sets the state of the calling plugin to activated.
- `Plugin:CreateDockWidgetPluginGuiAsync(pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui`：Creates a DockWidgetPluginGui given a DockWidgetPluginGuiInfo.
- `Plugin:CreatePluginAction(actionId: string, text: string, statusTip: string, iconName: string, allowBinding: boolean): PluginAction`：Creates a PluginAction which represents a generic performable action in Studio with no directly‑associated PluginToolbarButton.
- `Plugin:CreatePluginMenu(id: string, title: string, icon: string): PluginMenu`：Creates a new plugin menu.
- `Plugin:CreateToolbar(name: string): PluginToolbar`：Creates a new PluginToolbar with the given name.
- `Plugin:Deactivate(): ()`：Deactivates the plugin.
- `Plugin:GetJoinMode(): JointCreationMode`：Returns the JointCreationMode the user has set in Studio's toolbar.
- `Plugin:GetMouse(): PluginMouse`：Returns a Mouse that can be used while the plugin is active.
- `Plugin:GetSelectedRibbonTool(): RibbonTool`：Returns the currently selected RibbonTool.
- `Plugin:GetSetting(key: string): Variant`：Retrieves a previously stored value with the given key, or nil if the given key doesn't exist.
- `Plugin:ImportFbxAnimationAsync(rigModel: Instance, isR15: boolean): 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.
- `Plugin:ImportFbxRigAsync(isR15: boolean): 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.
- `Plugin:Intersect(objects: Instances): Instance`：Intersects the given parts and returns the resulting IntersectOperation.
- `Plugin:IsActivated(): boolean`：Returns true if this plugin is currently active, after having been activated via the Class.Plugin:Activate()|Activate() function.
- `Plugin:IsActivatedWithExclusiveMouse(): boolean`：Returns true if this plugin is currently active with an exclusive mouse.
- `Plugin:Negate(objects: Instances): Instances`：Negates the given parts and returns the resulting Class.NegateOperation|NegateOperations.
- `Plugin:OpenWikiPage(url: string): ()`：Opens the context help window to the wiki page that url links to.
- `Plugin:PromptForExistingAssetId(assetType: string): int64`：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.
- `Plugin:PromptForExistingAssetIdAsync(assetType: string): int64`：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.
- `Plugin:PromptSaveSelectionAsync(suggestedFileName: string): boolean`：Prompts the user to save their current selection with the specified file name.
- `Plugin:SaveSelectedToRoblox(): ()`：Opens an upload window for the user's current selection.
- `Plugin:SelectRibbonTool(tool: RibbonTool, position: UDim2): ()`：Activates the specified Roblox Studio tool.
- `Plugin:Separate(objects: Instances): Instances`：Separates the given Class.UnionOperation|UnionOperations and returns the resulting parts.
- `Plugin:SetSetting(key: string, value: Variant): ()`：Stores a given value for later use under the given key. The value will persist even after Studio is closed.
- `Plugin:StartDrag(dragData: Dictionary): ()`：Starts a drag action given a dictionary of parameters.
- `Plugin:Union(objects: Instances): Instance`：Unions the given parts and returns the resulting UnionOperation.

## イベント

- `Plugin.Deactivation()`：Fired when the plugin is deactivated.
- `Plugin.Unloading()`：Fires immediately before the Plugin stops running.

英語の説明とメンバー一覧：Roblox Creator Documentation（CC BY 4.0）。日本語の解説はこのサイト独自のものです。

執筆：鈴木孝昌（現役プロジェクトマネージャー／プログラミング講師）／運営：沖縄マイクラ部 プログラミングスクール「クロスウェーブ」（https://minecraft-okinawa.com/）