Pluginクラス
ひとことで言うと
Pluginは、ロブロックス(Roblox)のクラスです。くわしい日本語解説は準備中のため、下に公式の説明(英語)を載せています。
公式の説明(英語):The main object responsible for creating custom Studio widgets, toolbars, buttons, and other plugin UI elements.
クラスの関係
プロパティ(2)
| 名前と書き方 | 説明 |
|---|---|
CollisionEnabledPlugin.CollisionEnabled: boolean | Returns whether the user has enabled **Collisions** in Studio's toolbar. |
GridSizePlugin.GridSize: float | Returns the grid snapping size the user has set in Studio. |
メソッド(26)
| 名前と書き方 | 説明 |
|---|---|
ActivatePlugin:Activate(exclusiveMouse: boolean): () | Sets the state of the calling plugin to activated. |
CreateDockWidgetPluginGuiAsyncPlugin:CreateDockWidgetPluginGuiAsync(pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui | Creates a DockWidgetPluginGui given a DockWidgetPluginGuiInfo. |
CreatePluginActionPlugin: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. |
CreatePluginMenuPlugin:CreatePluginMenu(id: string, title: string, icon: string): PluginMenu | Creates a new plugin menu. |
CreateToolbarPlugin:CreateToolbar(name: string): PluginToolbar | Creates a new PluginToolbar with the given name. |
DeactivatePlugin:Deactivate(): () | Deactivates the plugin. |
GetJoinModePlugin:GetJoinMode(): JointCreationMode | Returns the JointCreationMode the user has set in Studio's toolbar. |
GetMousePlugin:GetMouse(): PluginMouse | Returns a Mouse that can be used while the plugin is active. |
GetSelectedRibbonToolPlugin:GetSelectedRibbonTool(): RibbonTool | Returns the currently selected RibbonTool. |
GetSettingPlugin:GetSetting(key: string): Variant | Retrieves a previously stored value with the given key, or nil if the given key doesn't exist. |
ImportFbxAnimationAsyncPlugin: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. |
ImportFbxRigAsyncPlugin: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. |
IntersectPlugin:Intersect(objects: Instances): Instance | Intersects the given parts and returns the resulting IntersectOperation. |
IsActivatedPlugin:IsActivated(): boolean | Returns true if this plugin is currently active, after having been activated via the Class.Plugin:Activate()|Activate() function. |
IsActivatedWithExclusiveMousePlugin:IsActivatedWithExclusiveMouse(): boolean | Returns true if this plugin is currently active with an exclusive mouse. |
NegatePlugin:Negate(objects: Instances): Instances | Negates the given parts and returns the resulting Class.NegateOperation|NegateOperations. |
OpenWikiPagePlugin:OpenWikiPage(url: string): () | Opens the context help window to the wiki page that url links to. |
PromptForExistingAssetIdPlugin: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. |
PromptForExistingAssetIdAsyncPlugin: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. |
PromptSaveSelectionAsyncPlugin:PromptSaveSelectionAsync(suggestedFileName: string): boolean | Prompts the user to save their current selection with the specified file name. |
SaveSelectedToRobloxPlugin:SaveSelectedToRoblox(): () | Opens an upload window for the user's current selection. |
SelectRibbonToolPlugin:SelectRibbonTool(tool: RibbonTool, position: UDim2): () | Activates the specified Roblox Studio tool. |
SeparatePlugin:Separate(objects: Instances): Instances | Separates the given Class.UnionOperation|UnionOperations and returns the resulting parts. |
SetSettingPlugin: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. |
StartDragPlugin:StartDrag(dragData: Dictionary): () | Starts a drag action given a dictionary of parameters. |
UnionPlugin:Union(objects: Instances): Instance | Unions the given parts and returns the resulting UnionOperation. |
イベント(2)
| 名前と書き方 | 説明 |
|---|---|
DeactivationPlugin.Deactivation() | Fired when the plugin is deactivated. |
UnloadingPlugin.Unloading() | Fires immediately before the Plugin stops running. |
受け継いでいるメンバー
Instance から受け継いでいるもの(46)
Archivable・Capabilities・IsInSandbox・Name・Parent・PredictionMode・Sandboxed・AddTag・ClearAllChildren・Clone・Destroy・FindFirstAncestor・FindFirstAncestorOfClass・FindFirstAncestorWhichIsA・FindFirstChild・FindFirstChildOfClass・FindFirstChildWhichIsA・FindFirstDescendant・GetActor・GetAttribute・GetAttributeChangedSignal・GetAttributes・GetChildren・GetDebugId・GetDescendants・GetFullName・GetStyled・GetStyledPropertyChangedSignal・GetTags・HasTag・IsAncestorOf・IsDescendantOf・IsPropertyModified・QueryDescendants・RemoveTag・ResetPropertyToDefault・SetAttribute・WaitForChild・AncestryChanged・AttributeChanged・ChildAdded・ChildRemoved・DescendantAdded・DescendantRemoving・Destroying・StyledPropertiesChanged
Object から受け継いでいるもの(4)
英語の説明とメンバーの一覧は、Roblox Creator Documentation(Plugin)をもとにしています(CC BY 4.0)。日本語の解説は、このサイトで独自に書いたものです。