Plugin

Zwraca, czy użytkownik włączył Collisions w Studio w zakładce Model.

Zwraca rozmiar przesuwania siatki, który użytkownik ustawił w Studio w zakładkach Model lub Awatar pod paskiem narzędzi.Zauważ, że ta właściwość może mieć niewielkie błędy zaokrąglenia; na przykład może to być 0.0099999997764826 dla ustawienia użytkownika 1 lub 0.4000000059604645 dla ustawienia użytkownika 0.4.

Funkcja ta ustawia stan wzywanego pluginu na aktywny. Aktywacja pluginu umożliwia kontrolę myszy za pomocą metody Plugin:GetMouse().

W dowolnym momencie istnieje 0 lub 1 aktywowanych pluginów.Aktywacja wtyczki dezaktywuje wszystkie inne wtyczki (otrzymają wydarzenie Plugin.Deactivation).

Zobacz także:

• Plugin:IsActivatedWithExclusiveMouse() , zwraca prawdę, jeśli ten plugin jest obecnie aktywny z ekskluzywną myszką, po aktywacji za pomocą tej funkcji
• Plugin.Unloading , zapala się natychmiast przed rozładowaniem lub ponownym załadowaniem wtyczki za pomocą dezaktywacji, dezaktywacji lub aktualizacji

Parametry

Zwroty

Funkcja ta tworzy PluginAction, który jest obiektem reprezentującym ogólną wykonalną akcję w Roblox Studio, bezpośrednio nie powiązaną z Toolbar lub Enum.Button.W Roblox Studio mogą one otrzymać skrót klawiszowy pod File → Advanced → Customize Shortcuts…, a także mogą być dodane do paska narzędzi Szybkiego dostępu.

Gdy akcja jest uruchamiana, sygnalizowane jest wydarzenie PluginAction.Triggered.

Aby akcje pluginów działały zgodnie z oczekiwaniami, muszą być tworzone za pomocą tej funkcji.

Zobacz także:

• PluginMenu , menu kontekstowe, które można wyświetlić w Studio, które wyświetla listę akcji pluginów i wspiera podmenu
• Plugin:CreatePluginMenu() , tworzy menu pluginów

Parametry

Zwroty

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)

Funkcja ta tworzy nowe PluginMenu, które jest menu kontekstowym, które można wyświetlić w Studio i wyświetla listę PluginActions oraz wspiera podmenu.

Aby menu pluginów działało tak, jak oczekiwano, muszą one zostać utworzone za pomocą tej funkcji.

Zobacz także:

• PluginAction , obiekt reprezentujący ogólną wykonalną akcję w Roblox Studio, bezpośrednio nie powiązany z Toolbar lub Enum.Button.
• Plugin:CreatePluginAction() , tworzy akcję pluginu
• PluginMenu.Title , tekst wyświetlany przy użyciu jako podmenu
• PluginMenu.Icon , ikona, która będzie wyświetlana, gdy używana jako podmenu
• PluginMenu:AddAction() , dodaje podane działanie do menu
• PluginMenu:AddNewAction() , tworzy tymczasowe działanie, które jest ukryte przed oknem dostosowywania skrótów Studio
• PluginMenu:AddMenu() , dodaje podane menu jako separator
• PluginMenu:AddSeparator() , dodaje separator między elementami w menu
• PluginMenu:Clear() , oczyszcza menu
• PluginMenu:ShowAsync() , pokazuje menu przy kursorowaniu myszy.Poddaje się, dopóki nie zostanie wybrany przedmiot lub zamknięte menu.Wybrana akcja uruchamia swoje uruchomione wydarzenie

Parametry

Zwroty

-- 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)

Funkcja tworzenia paska narzędzi tworzy nowy PluginToolbar z podaną nazwą. Pasek narzędzi może następnie być używany do tworzenia przycisków pluginów.

Parametry

Zwroty

plugin:CreateToolbar("ExampleToolbar")

Dezaktywuje dodatek plug-in. Spowoduje to odłączenie powiązanego PluginMouse, jeśli został aktywowany

Zobacz także:

• Plugin:Activate() , ustawia stan wtyczki wezwania na aktywny
• Plugin.Deactivation , wypala się, gdy wtyczka jest wyłączona
• Plugin.Unloading , zapala się natychmiast przed rozładowaniem lub ponownym załadowaniem wtyczki za pomocą dezaktywacji, dezaktywacji lub aktualizacji

Zwroty

Zwraca Enum.JointCreationMode użytkownik ustawił w Studio w zakładce Model.

Zwroty

Zdobądź mysz zwraca PluginMouse, które można używać, gdy wtyczka jest aktywna poprzez Plugin:Activate() .

Zwroty

local mouse = plugin:GetMouse()

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

mouse.Button1Down:Connect(button1Down)

GetSelectedRibbonTool zwraca obecnie wybrane Enum.RibbonTool .Zwraca Enum, które odpowiada konkretnemu narzędziu.Wynikiem tego będzie to, czy narzędzie zostało wybrane ręcznie lub programowo za pomocą Plugin:SelectRibbonTool() .

Zwroty

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

Zwraca wcześniej zapisany wartość z podanym kluczem, lub nil jeśli podany klucz nie istnieje.

Ponieważ wiele instancji tego samego pluginu może działać jednocześnie (na przykład, jeśli wiele okien Studio jest otwartych), nie powinieneś polegać na tym, że ta wartość pozostaje taka sama z czasem.Inne instancje pluginów mogą aktualizować ustawienie w dowolnym momencie.

Wezwanie to może cicho zawieść i zwrócić nil, jeśli wiele instancji tego samego pluginu aktywnie odczytuje i zapisuje dane.Jeśli twój plugin oczekuje pisania do ustawień często, powinieneś sprawdzić dwukrotnie zwróconą wartość z tego wezwania po krótkim czasie, aby odróżnić ustawienie tymczasowo niedostępne od ustawienia niewystępującego.

Parametry

Zwroty

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

Parametry

Zwroty

Funkcja ta zwraca prawdę, jeśli ten plugin jest obecnie aktywny, po aktywacji za pomocą funkcji Plugin:Activate().

Zwroty

Funkcja ta zwraca prawdę, jeśli ten plugin jest obecnie aktywny z ekskluzywną myszką, po aktywacji za pomocą funkcji Plugin:Activate().Jeśli to zwraca prawdę, PluginMouse można odzyskać za pomocą Plugin:GetMouse() .

Zobacz także:

• Plugin.Deactivation , wypala się, gdy wtyczka jest wyłączona
• Plugin.Unloading , zapala się natychmiast przed rozładowaniem lub ponownym załadowaniem wtyczki za pomocą dezaktywacji, dezaktywacji lub aktualizacji

Zwroty

Odrzuca podane części i zwraca wynikowe operacje zaprzeczania.

Parametry

Zwroty

Używany do otwierania danego przykładu skryptu w oknie edytora, w Roblox Studio, na danej linii.Jeśli nie zostanie podana linia jako argument, domyślnie zostanie ustawiona na 1.

Parametry

Zwroty

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

Otwiera okno pomocy kontekstowej na stronę wiki, do której łączy się url.

Parametry

Zwroty

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

Otwiera okno przesyłania dla obecnego wyboru użytkownika.

Zwroty

Aktywuje określone narzędzie Roblox Studio. Jeśli narzędzie otwiera okno, parametr pozycji określa, gdzie powinno być wyświetlone na ekranie.

Uwaga:

• Musi zostać wybrany obiekt, aby to działało poprawnie.
• Zmiana pól skali właściwości position nie wpłynie na okienka dialogowe.

Parametry

Zwroty

Rozdziela podane operacje związane z unią i zwraca uzyskane części.

Parametry

Zwroty

Przechowuje określoną wartość na późniejsze użycie pod danym kluczem.Wartość będzie istnieć nawet po zamknięciu Roblox Studio.Te ustawienia są zapisywane w formacie JSON jako mapa z kluczami ciągów.Matryce są automatycznie konwertowane na mapy, konwertując najpierw klucze liczbowe na struny.

Zauważ, że format JSON narzuca dodatkowe ograniczenia, w tym następujące znaki, które mogą zniszczyć plik ustawień:

• Wsteczki ( \ ) w kluczach lub wartościach, w szczególności uciekłe cytaty ( \" ).
• Nowe linie ( \n ) w kluczach.
• Cytaty ( " ) w kluczach.
• Okresy ( . ) w kluczach.

Wezwanie to może cicho zawieść, jeśli wiele instancji tego samego pluginu aktywnie odczytuje i zapisuje dane.Jeśli twój plugin oczekuje pisania do ustawień często, możesz sprawdzić, czy dane zostały poprawnie napisane, wywołując Plugin:GetSetting() .

Parametry

Zwroty

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

Rozpoczęcie przeciągania inicjuje akcję przeciągania za pomocą słownika parametrów. Parametry są następujące:

<th>Typ</th>

    <th>Domyślny</th>

    <th>Opis</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><b>Nadawca</b></td><td>ciąg</td><td><code>""</code></td>

    <td>
      Określa źródło akcji przeciągania do celu upuszczenia
    </td>
  </tr>

  <tr>
    <td><b>Typ mime</b></td><td>strunę</td><td><code>""</code></td>

    <td>
      Typ <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME</a> rodzaju <b>danych</b>.
    </td>
  </tr>

  <tr>
    <td><b>Dane</b></td><td>struny</td><td><code>""</code> ></td>

    <td>
      Informacje o akcji przeciągania, na przykład o tym, co jest przeciągane. Powinny być używane przez cel upuszczenia.
    </td>
  </tr>

  <tr>
    <td><b>Ikona myszy</b></td><td><code>Typ danych.Content</code> ></td><td><code>""</code> ></td>

    <td>
      Ikona, którą należy używać dla kurora myszy podczas przeciągania. Jeśli jest pusta, używa domyślnego kurora.
    </td>
  </tr>

  <tr>
    <td><b>Przeciągnij ikonę</b></td><td><code>Typ danych.Content</code> ></td><td><code>""</code> ></td>

    <td>
      Obraz do renderowania pod kursorem myszy podczas przeciągania. Powinien reprezentować przedmiot, który jest przeciągany.
    </td>
  </tr>

  <tr>
    <td><b>Punkt gorący</b></td><td><code>Typ danych.Vector2</code></td><td><code>Typ danych.Vector2.new(0, 0)</code></td>

    <td>
      Odległość piksela od lewej góry, gdzie kurser powinien "przytrzymać" <b>ikonę przeciągania</b>.
    </td>
  </tr>
</tbody>

Zobacz także:

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

Parametry

Zwroty

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)

Połącza podane części i zwraca wynikową operację związku.

Parametry

Zwroty

CreateDockWidgetPluginGui tworzy nowy DockWidgetPluginGui z podanego DockWidgetPluginGuiInfo.Pierwszy parametr, pluginGuiId, powinien być unikalną i spójną ciąg.Służy do zapisywania stanu docka widgetu i innych wewnętrznych szczegółów.

Parametry

Zwroty

-- 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

Funkcja ta wymaga od użytkownika otwarcia pliku animacji .fbx, który można załadować na rigModel, a następnie dokonuje wstawienia animacji jako KeyframeSequence w Workspace.

Parametry

Zwroty

Wymaga od użytkownika otwarcia pliku .fbx, przesyła poszczególne komponenty modelu jako siatki i generuje postać do użycia w animacja, która jest wczytywana w Workspace.

Parametry

Zwroty

Otwiera okno w Roblox Studio, które wymaga od użytkownika wyboru zasobu na podstawie określonego assetType.Zwraca, jaki ID aktywa został wybrany, lub -1, jeśli okno zostało zamknięte.

Parametry

Zwroty

Wymaga od użytkownika zapisanie obecnego wyboru za pomocą określonej nazwy pliku. Powraca prawdą, jeśli użytkownik zapisał plik.

Parametry

Zwroty

Wystrzeliwany, gdy Plugin jest wyłączony.Występuje to, gdy kod pluginów wezwie Plugin:Deactivate() lub dlatego, że jakiś inny plugin nazwał Plugin:Activate(), który zmusza wszystkie inne pluginy do utraty aktywnego stanu.

Zobacz także:

• Plugin.Unloading , zapala się natychmiast przed rozładowaniem lub ponownym załadowaniem wtyczki za pomocą dezaktywacji, dezaktywacji lub aktualizacji

To wydarzenie uruchamia się natychmiast przed tym, jak Plugin przestanie działać.Wtyczki są rozładowane, gdy są wyłączone, usuwane, mają zostać zaktualizowane lub gdy miejsce się zamyka.

Umożliwia pluginowi sprzątanie po sobie, zanim jego skrypty przestaną działać, np.aby usunąć niepotrzebne instancje z DataModel.Jeśli wtyczka nie zostanie prawidłowo wyczyszczona, pozostaną stare kopie.Kiedy to się zdarza, użytkownicy mogą zostać zmuszeni do zamknięcia i ponownego otwarcia miejsca, które jest złym doświadczeniem użytkownika.

Instancje związane z wtyczkami, takie jak PluginToolbarButtons , DockWidgetPluginGuis i PluginGuis są automatycznie czyszczone, gdy wtyczka jest rozładowywana, więc nie ma potrzeby ich usuwania.