Plugin

Restituisce se l'utente ha abilitato Collisions in Studio sotto la scheda Modello.

Restituisce la dimensione di aggancio della griglia che l'utente ha impostato in Studio sotto le schede Modello o Avatar della barra degli strumenti.Si noti che questa proprietà può avere lievi errori di arrotondamento; ad esempio può essere 0.0099999997764826 per una impostazione utente di 1 o 0.4000000059604645 per una impostazione utente di 0.4 .

Questa funzione imposta lo stato del plugin di chiamata in attivato. L'attivazione del plugin consente il controllo del mouse attraverso il metodo Plugin:GetMouse().

In qualsiasi momento ci sono 0 o 1 plugin attivati.L'attivazione di un plugin disattiverà tutti gli altri plugin ( riceveranno un evento Plugin.Deactivation ).

Vedi anche:

• Plugin:IsActivatedWithExclusiveMouse() , restituisce vero se questo plugin è attualmente attivo con un topo, or mouse as computer mouseesclusivo, dopo essere stato attivato tramite questa funzione
• Plugin.Unloading , si attiva immediatamente prima che il plugin venga disinstallato o ricaricato via disattivazione o aggiornamento

Parametri

Restituzioni

Questa funzione crea un PluginAction che è un oggetto che rappresenta un'azione generica eseguibile in Roblox Studio, senza alcun Toolbar o Enum.Button direttamente associato.In Roblox Studio, possono essere assegnati scorciatoie da tastiera sotto File → Advanced → Customize Shortcuts… e possono anche essere aggiunti alla barra di accesso rapido.

Quando un'azione viene attivata, l'evento PluginAction.Triggered viene segnalato.

Affinché le azioni del plugin funzionino come previsto, devono essere create utilizzando questa funzione.

Vedi anche:

• PluginMenu , un menu contestuale che può essere mostrato in Studio che visualizza una lista di PluginActions e supporta i sott menu
• Plugin:CreatePluginMenu() , crea un PluginMenu

Parametri

Restituzioni

local pluginAction = plugin:CreatePluginAction(
	"HelloWorldAction",
	"Hello World",
	"Prints a 'Hello world!'",
	"rbxasset://textures/sparkle.png",
	true
)
pluginAction.Name = "Test Action"

local function actionTriggered()
	print("Hello world!")
end

pluginAction.Triggered:Connect(actionTriggered)

Questa funzione crea un nuovo PluginMenu , che è un menu contestuale che può essere mostrato in Studio che visualizza una lista di PluginActions e supporta i sott menu.

Affinché i menu plugin funzionino come previsto, devono essere creati utilizzando questa funzione.

Vedi anche:

• PluginAction , un oggetto che rappresenta un'azione generica eseguibile in Roblox Studio, senza alcun Toolbar o Enum.Button direttamente associato.
• Plugin:CreatePluginAction() , crea un'azione di plugin
• PluginMenu.Title , il testo da mostrare quando viene utilizzato come sottomenù
• PluginMenu.Icon , l'icona da mostrare quando viene utilizzata come sottomenù
• PluginMenu:AddAction() , aggiunge l'azione data al menu
• PluginMenu:AddNewAction() , crea un'azione temporanea che è nascosta dalla finestra di personalizzazione scorciatoie di Studio
• PluginMenu:AddMenu() , aggiunge il menu fornito come separatore
• PluginMenu:AddSeparator() , aggiunge un separatore tra gli elementi nel menu
• PluginMenu:Clear() , cancella il menu
• PluginMenu:ShowAsync() , mostra il menu al cursore del mouse.Produce fino a quando un oggetto non viene selezionato o il menu non viene chiuso.L'azione selezionata lancia il suo evento Triggered

Parametri

Restituzioni

-- This code can be pasted into the command bar, but only once
local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")
pluginMenu.Name = "Test Menu"

pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")
pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")

local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")
subMenu.Name = "Sub Menu"

subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")
subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")

pluginMenu:AddMenu(subMenu)
pluginMenu:AddSeparator()

pluginMenu:AddNewAction("ActionF", "F", "rbxasset://textures/sparkle.png")

local toggle = Instance.new("BoolValue")
toggle.Name = "TogglePluginMenu"
toggle.Parent = workspace

local function onToggled()
	if toggle.Value then
		toggle.Value = false

		local selectedAction = pluginMenu:ShowAsync()
		if selectedAction then
			print("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)
		else
			print("User did not select an action!")
		end
	end
end

toggle.Changed:Connect(onToggled)

La funzione CreateToolbar crea una nuova PluginToolbar con il nome fornito. La barra degli strumenti può quindi essere utilizzata per creare pulsanti di plugin.

Parametri

Restituzioni

plugin:CreateToolbar("ExampleToolbar")

Disattiva il Collegare. Ciò disattiverà il PluginMouse associato se è stato attivato

Vedi anche:

• Plugin:Activate() , imposta lo stato del plugin di chiamata in attivato
• Plugin.Deactivation , si attiva quando il plugin è disattivato
• Plugin.Unloading , si attiva immediatamente prima che il plugin venga disinstallato o ricaricato via disattivazione o aggiornamento

Restituzioni

Restituisce il Enum.JointCreationMode l'utente ha impostato in Studio sotto la scheda Modello.

Restituzioni

GetMouse restituisce un PluginMouse che può essere utilizzato mentre il plugin è attivo attraverso Plugin:Activate() .

Restituzioni

local mouse = plugin:GetMouse()

local function button1Down()
	print("Button 1 pressed from PluginMouse")
end

mouse.Button1Down:Connect(button1Down)

GetSelectedRibbonTool restituisce l'attuale strumento selezionato Enum.RibbonTool .Restituisce un Enum che corrisponde a uno strumento particolare.Questo restituirà se lo strumento viene selezionato manualmente o programmaticamente tramite Plugin:SelectRibbonTool() .

Restituzioni

plugin:SelectRibbonTool(Enum.RibbonTool.Move, UDim2.new())
task.wait() -- wait for next frame
local selectedRibbonTool = plugin:GetSelectedRibbonTool()
print("The selected RibbonTool is", selectedRibbonTool)

Recupera un valore precedentemente memorizzato con la chiave data, o nil se la chiave data non esiste.

Poiché più istanze dello stesso plugin possono essere eseguite contemporaneamente (ad esempio, se più finestre di Studio sono aperte), non dovresti dipendere da questo valore che rimane lo stesso nel tempo.Le altre istanze di plugin possono aggiornare la configurazione in qualsiasi momento.

Questa chiamata può fallire silenziosamente e restituire nil se più istanze dello stesso plugin stanno leggendo e scrivendo attivamente dati.Se il tuo plugin si aspetta di scrivere spesso nelle impostazioni, dovresti controllare due volte il valore restituito da questa chiamata dopo un breve lasso di tempo per distinguere tra una impostazione non disponibile temporaneamente e una impostazione non esistente.

Parametri

Restituzioni

local RAN_BEFORE_KEY = "RanBefore"
local didRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)

if didRunBefore then
	print("Welcome back!")
else
	plugin:SetSetting(RAN_BEFORE_KEY, true)
	print("Welcome! Thanks for installing this plugin!")
end

Parametri

Restituzioni

Questa funzione restituisce vero se questo plugin è attualmente attivo, dopo essere stato attivato tramite la funzione Plugin:Activate().

Restituzioni

Questa funzione restituisce vero se questo plugin è attualmente attivo con un Topo, or mouse as computer mouseesclusivo, dopo essere stato attivato tramite la funzione Plugin:Activate().Se questo restituisce vero, un PluginMouse può essere recuperato tramite Plugin:GetMouse() .

Vedi anche:

• Plugin.Deactivation , si attiva quando il plugin è disattivato
• Plugin.Unloading , si attiva immediatamente prima che il plugin venga disinstallato o ricaricato via disattivazione o aggiornamento

Restituzioni

Rimuove le parti date e restituisce le operazioni di negazione conseguenti.

Parametri

Restituzioni

Utilizzato per aprire l'istanza dello script specificata in una finestra dell'editor, in Roblox Studio, alla linea specificata.Se non viene data una linea come argomento, prenderà per impostazione predefinita 1.

Parametri

Restituzioni

local newScript = Instance.new("Script")
newScript.Parent = workspace
plugin:OpenScript(newScript)

Apre la finestra di aiuto del contesto alla pagina wiki a cui url linka.

Parametri

Restituzioni

plugin:OpenWikiPage("API:Class/BasePart")

Apre una finestra di caricamento per la selezione attuale dell'utente.

Restituzioni

Attiva lo strumento Roblox Studio specificato. Se lo strumento apre una finestra, il parametro posizione specifica dove deve essere mostrato sullo schermo.

Nota:

• Deve essere selezionato un oggetto affinché questo funzioni correttamente.
• La modifica dei campi di scala della proprietà position non influirà sui popup di dialogo.

Parametri

Restituzioni

Separa le UnionOperations date e restituisce le parti risultanti.

Parametri

Restituzioni

Memorizza un valore dato per un uso successivo sotto la chiave indicata.Il valore persisterà anche dopo che Roblox Studio è stato chiuso.Queste impostazioni vengono salvate nel formato JSON come mappa con chiavi di stringa.Gli array vengono automaticamente convertiti in mappe convertendo prima le chiavi numeriche in stringhe.

Si noti che il formato JSON impone restrizioni aggiuntive, tra cui i seguenti caratteri che possono corrompere il file delle impostazioni:

• Backslashes ( \ ) in chiavi o valori, in particolare quote scappate ( \" ).
• Nuove righe ( \n ) nelle chiavi.
• Quote ( " ) in chiavi.
• Periodi ( . ) nelle chiavi.

Questa chiamata può fallire silenziosamente se più istanze dello stesso plugin stanno leggendo e scrivendo attivamente dati.Se il tuo plugin si aspetta di scrivere spesso nelle impostazioni, puoi controllare che i dati sono stati scritti correttamente chiamando Plugin:GetSetting() .

Parametri

Restituzioni

local RAN_BEFORE_KEY = "RunBefore"
local hasRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)

if hasRunBefore then
	print("Welcome back!")
else
	print("Thanks for installing this plugin!")
	plugin:SetSetting(RAN_BEFORE_KEY, true)
end

StartDrag inizia un'azione di trascinamento utilizzando un dizionario di parametri. I parametri sono i seguenti:

<th>Tipo</th>

    <th>Basilare</th>

    <th>Descrizione</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><b>mittente</b></td><td>stringa</td><td><code>""</code> ></td>

    <td>
      Identifica la fonte dell'azione di trascinamento al bersaglio di rilascio
    </td>
  </tr>

  <tr>
    <td><b>MimeType</b></td><td>string</td><td><code>""</code> ></td>

    <td>
      Il tipo <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME</a> di <b>Dati</b>.
    </td>
  </tr>

  <tr>
    <td><b>Dati</b></td><td>stringa</td><td><code>""</code> ></td>

    <td>
      Informazioni sull'azione di trascinamento, ad esempio cosa viene trascinato. Dovrebbe essere utilizzato dal bersaglio di rilascio.
    </td>
  </tr>

  <tr>
    <td><b>MouseIcon</b></td><td><code>Datatype.Content</code> ></td><td><code>""</code> ></td>

    <td>
      L'icona da utilizzare per il cursore del mouse durante il trascinamento. Se vuoto, utilizza il cursore predefinito.
    </td>
  </tr>

  <tr>
    <td><b>DragIcon</b></td><td><code>Datatype.Content</code> ></td><td><code>""</code> ></td>

    <td>
      Un'immagine da rendere sotto il cursore del mouse durante il trascinamento. Questo dovrebbe rappresentare l'elemento che viene trascinato.
    </td>
  </tr>

  <tr>
    <td><b>HotSpot</b></td><td><code>Datatype.Vector2</code></td><td><code>Datatype.Vector2.new(0, 0)</code> ></td>

    <td>
      Lo spostamento del pixel dalla parte superiore sinistra in cui il cursore dovrebbe "tenere premuto" il <b>DragIcon</b>.
    </td>
  </tr>
</tbody>

Vedi anche:

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

Parametri

Restituzioni

assert(plugin, "This script must be run as a Studio plugin")

local widgetInfo = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 300, 200)

local dragSourceWidget = plugin:CreateDockWidgetPluginGui("Drag Source", widgetInfo)
dragSourceWidget.Title = "Drag Source"

local textBox = Instance.new("TextBox")
textBox.Parent = dragSourceWidget
textBox.Size = UDim2.new(1, 0, 0, 32)
textBox.Text = "Hello, plugin drags"

local dragButton = Instance.new("TextButton")
dragButton.Size = UDim2.new(1, 0, 1, -32)
dragButton.Position = UDim2.new(0, 0, 0, 32)
dragButton.Text = "Edit the text above, then start drag here"
dragButton.Parent = dragSourceWidget

function onMouseButton1Down()
	local dragData = {
		Sender = "SomeDragSource",
		MimeType = "text/plain",
		Data = textBox.Text,
		MouseIcon = "",
		DragIcon = "",
		HotSpot = Vector2.new(0, 0),
	}
	plugin:StartDrag(dragData)
end

dragButton.MouseButton1Down:Connect(onMouseButton1Down)

-- This widget will receive drops
local dragTargetWidget = plugin:CreateDockWidgetPluginGui("Drop Target", widgetInfo)
dragTargetWidget.Title = "Drop Target"

-- This TextLabel will display what was dropped
local textLabel = Instance.new("TextLabel")
textLabel.Size = UDim2.new(1, 0, 1, 0)
textLabel.Text = "Drop here..."
textLabel.Parent = dragTargetWidget

local function onDragDrop(dragData)
	if dragData.MimeType == "text/plain" then
		textLabel.Text = dragData.Data
	else
		textLabel.Text = dragData.MimeType
	end
end

dragTargetWidget.PluginDragDropped:Connect(onDragDrop)

dragTargetWidget.PluginDragEntered:Connect(function(_dragData)
	print("PluginDragEntered")
end)

dragTargetWidget.PluginDragLeft:Connect(function(_dragData)
	print("PluginDragLeft")
end)

dragTargetWidget.PluginDragMoved:Connect(function(_dragData)
	print("PluginDragMoved")
end)

Unisce le parti date e restituisce l'UnionOperation risultante.

Parametri

Restituzioni

CreateDockWidgetPluginGui crea una nuova DockWidgetPluginGui da quella data DockWidgetPluginGuiInfo.Il primo parametro, pluginGuiId , dovrebbe essere una Stringaunica e coerente.Viene utilizzato per salvare lo stato della dock di widget e altri dettagli interni.

Parametri

Restituzioni

-- Create new 'DockWidgetPluginGuiInfo' object
local widgetInfo = DockWidgetPluginGuiInfo.new(
	Enum.InitialDockState.Float, -- Widget will be initialized in floating panel
	true, -- Widget will be initially enabled
	false, -- Don't override the previous enabled state
	200, -- Default width of the floating window
	300, -- Default height of the floating window
	150, -- Minimum width of the floating window (optional)
	150 -- Minimum height of the floating window (optional)
)

-- Create new widget GUI
local testWidget = plugin:CreateDockWidgetPluginGui("TestWidget", widgetInfo)

local testButton = Instance.new("TextButton")
testButton.BorderSizePixel = 0
testButton.TextSize = 20
testButton.TextColor3 = Color3.new(1, 0.2, 0.4)
testButton.AnchorPoint = Vector2.new(0.5, 0.5)
testButton.Size = UDim2.new(1, 0, 1, 0)
testButton.Position = UDim2.new(0.5, 0, 0.5, 0)
testButton.SizeConstraint = Enum.SizeConstraint.RelativeYY
testButton.Text = "Click Me"
testButton.Parent = testWidget

Questa funzione richiede all'utente di aprire un file di animazione .fbx che può essere caricato su rigModel , quindi procede ad inserire l'animazione come KeyframeSequence nel Workspace .

Parametri

Restituzioni

Invita l'utente ad aprire un file .fbx, carica le singole componenti del modello come mesh e genera un character rig per l'uso in animazioni, che viene caricato nel Workspace .

Parametri

Restituzioni

Apre una finestra in Roblox Studio, che richiede all'utente di selezionare un'asset in base al assetType specificato.Restituisce ciò che assetId è stato selezionato, o -1 se la finestra è stata chiusa.

Parametri

Restituzioni

Invita l'utente a salvare la selezione attuale con il nome del file specificato. Restituisce vero se l'utente ha salvato il file.

Parametri

Restituzioni

Spedito quando il Plugin è disattivato.Questo accade quando il codice del plugin chiama Plugin:Deactivate() , o perché qualche altro plugin chiama Plugin:Activate() , il che forza tutti gli altri plugin a perdere il loro stato attivo.

Vedi anche:

• Plugin.Unloading , si attiva immediatamente prima che il plugin venga disinstallato o ricaricato via disattivazione o aggiornamento

Questo evento si attiva immediatamente prima che il Plugin smetta di funzionare.I plugin vengono disattivati quando vengono disinstallati, sono in procinto di essere aggiornati o quando il luogo si sta chiudendo.

Consente a un plugin di pulire dopo se stesso prima che i suoi script smettano di funzionare, ad esempioper rimuovere le istanze non necessarie dal DataModel .Se un plugin non si pulisce correttamente, le vecchie copie rimarranno.Quando ciò accade, gli utenti possono essere costretti a chiudere e riaprire il luogo che è una cattiva esperienza utente.

Le istanze correlate al plugin come PluginToolbarButtons , DockWidgetPluginGuis e PluginGuis vengono pulite automaticamente quando il plugin viene disinstallato quindi non c'è bisogno di rimuoverle.