Plugin

Renvoie si l'utilisateur a activé Collisions dans Studio sous l'onglet modèle.

Renvoie la taille d'accrochage de grille que l'utilisateur a définie dans Studio sous les onglets modèle ou avatar du menu bar.Notez que cette propriété peut avoir des erreurs de rondeur légères ; par exemple, elle peut être 0.0099999997764826 pour un paramètre d'utilisateur de 1 ou 0.4000000059604645 pour un paramètre d'utilisateur de 0.4 .

Cette fonction définit l'état du plugin d'appel à activé. L'activation du plugin permet le contrôle de la souris via la méthode Plugin:GetMouse().

À tout moment, il y a 0 ou 1 plugin activé.L'activation d'un plugin désactivera tous les autres plugins (ils recevront un événement Plugin.Deactivation).

Voir aussi :

• Plugin:IsActivatedWithExclusiveMouse() , renvoie vrai si ce plugin est actuellement actif avec une souris exclusive, après avoir été activé via cette fonction
• Plugin.Unloading , se déclenche immédiatement avant que le plugin ne soit déchargé ou rechargé via désactivation, désinstallation ou mise à jour

Paramètres

Retours

Cette fonction crée un PluginAction qui est un objet qui représente une action générique exécutable dans Roblox Studio, sans lien direct avec Toolbar ou Enum.Button.Dans Roblox Studio, ils peuvent être attribués une raccourci clavier sous File → Advanced → Customize Shortcuts… , et ils peuvent également être ajoutés à la barre d'accès rapide.

Lorsqu'une action est déclenchée, l'événement PluginAction.Triggered est signalé.

Pour que les actions de plugin fonctionnent comme prévu, elles doivent être créées en utilisant cette fonction.

Voir aussi :

• PluginMenu , un menu contextuel qui peut être affiché dans Studio qui affiche une liste d'actions de plugin et prend en charge les sous-menus
• Plugin:CreatePluginMenu() , crée un PluginMenu

Paramètres

Retours

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)

Cette fonction crée un nouveau PluginMenu , qui est un menu contextuel qui peut être affiché dans Studio qui affiche une liste de PluginActions et prend en charge les sous-menus.

Pour que les menus de plugin fonctionnent comme prévu, ils doivent être créés en utilisant cette fonction.

Voir aussi :

• PluginAction , un objet qui représente une action générique exécutable dans Roblox Studio, sans Toolbar ou Enum.Button directement associée.
• Plugin:CreatePluginAction() , crée une action de plugin
• PluginMenu.Title , le texte à afficher lorsqu'il est utilisé comme sous-menu
• PluginMenu.Icon , l'icône à afficher lorsqu'elle est utilisée comme sous-menu
• PluginMenu:AddAction() , ajoute l'action donnée au menu
• PluginMenu:AddNewAction() , crée une action temporaire qui est cachée de la fenêtre de raccourcis personnalisés de Studio
• PluginMenu:AddMenu() , ajoute le menu donné comme séparateur
• PluginMenu:AddSeparator() , ajoute un séparateur entre les éléments dans le menu
• PluginMenu:Clear() , efface le menu
• PluginMenu:ShowAsync() , montre le menu au curseur de la souris.Rendement jusqu'à ce qu'un élément soit sélectionné ou que le menu soit fermé.L'action sélectionnée déclenche son événement déclenché

Paramètres

Retours

-- 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 fonction Créer une barre d'outils crée une nouvelle PluginToolbar avec le nom donné. La barre d'outils peut ensuite être utilisée pour créer des boutons de plugin.

Paramètres

Retours

plugin:CreateToolbar("ExampleToolbar")

Désactive le plugin. Cela désengagera le PluginMouse associé s'il a été activé

Voir aussi :

• Plugin:Activate() , définit l'état du plugin d'appel à activé
• Plugin.Deactivation , se déclenche lorsque le plugin est désactivé
• Plugin.Unloading , se déclenche immédiatement avant que le plugin ne soit déchargé ou rechargé via désactivation, désinstallation ou mise à jour

Retours

Retourne le Enum.JointCreationMode que l'utilisateur a défini dans Studio sous l'onglet modèle.

Retours

GetMouse renvoie un PluginMouse qui peut être utilisé pendant que le plugin est actif via Plugin:Activate() .

Retours

local mouse = plugin:GetMouse()

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

mouse.Button1Down:Connect(button1Down)

GetSelectedRibbonTool renvoie l'outil Enum.RibbonTool sélectionné actuellement.Il renvoie un Enum correspondant à un outil spécifique.Cela retournera si l'outil est sélectionné manuellement ou programmatiquement via Plugin:SelectRibbonTool() .

Retours

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

Récupère une valeur précédemment stockée avec la clé donnée, ou nil si la clé donnée n'existe pas.

Comme plusieurs instances du même plugin peuvent s'exécuter simultanément (par exemple, si plusieurs fenêtres Studio sont ouvertes), vous ne devriez pas dépendre de cette valeur qui reste la même au fil du temps.Les autres instances de plugin peuvent mettre à jour le paramètre à tout moment.

Cet appel peut échouer silencieusement et retourner nil si plusieurs instances du même plugin lisent et écrivent activement des données.Si votre plugin s'attend à écrire souvent dans les paramètres, vous devriez vérifier deux fois la valeur renvoyée par cet appel après un court laps de temps pour distinguer entre un paramètre temporairement indisponible et un paramètre non existant.

Paramètres

Retours

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

Paramètres

Retours

Cette fonction renvoie true si ce plugin est actuellement actif, après avoir été activé via la fonction Plugin:Activate().

Retours

Cette fonction renvoie true si ce plugin est actuellement actif avec une souris exclusive, après avoir été activé via la fonction Plugin:Activate().Si cela renvoie vrai, un PluginMouse peut être récupéré via Plugin:GetMouse() .

Voir aussi :

• Plugin.Deactivation , se déclenche lorsque le plugin est désactivé
• Plugin.Unloading , se déclenche immédiatement avant que le plugin ne soit déchargé ou rechargé via désactivation, désinstallation ou mise à jour

Retours

Nie les parties données et renvoie les opérations de négation résultantes.

Paramètres

Retours

Utilisé pour ouvrir l'instance de script donnée dans une fenêtre de l'éditeur, dans Roblox Studio, à la ligne donnée.Si aucune ligne n'est donnée en argument, elle sera par défaut à 1.

Paramètres

Retours

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

Ouvre la fenêtre d'aide contextuelle sur la page du wiki à laquelle url liens.

Paramètres

Retours

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

Ouvre une fenêtre de téléchargement pour la sélection actuelle de l'utilisateur.

Retours

Active l'outil Roblox Studio spécifié. Si l'outil ouvre une fenêtre, le paramètre de position indique où il doit être affiché sur l'écran.

Remarque :

• Un objet doit être sélectionné afin que cela fonctionne correctement.
• Le changement des champs d'échelle de la propriété position n'affectera pas les popups de dialogue.

Paramètres

Retours

Sépare les opérations d'union données et renvoie les parties résultantes.

Paramètres

Retours

Stocke une valeur donnée pour une utilisation ultérieure sous la clé donnée.La valeur persiste même après la fermeture de Roblox Studio.Ces paramètres sont enregistrés au format JSON comme une carte avec des clés de chaîne.Les tableaux sont automatiquement convertis en cartes en convertissant d'abord les clés numériques en chaînes.

Notez que le format JSON impose des restrictions supplémentaires, y compris les caractères suivants qui peuvent corrompre le fichier de paramètres :

• Retours arrière ( \ ) dans les clés ou les valeurs, en particulier les citations échappées ( \" ).
• Nouvelles lignes ( \n ) dans les clés.
• Citations ( " ) dans les clés.
• Périodes ( . ) dans les clés.

Cet appel peut échouer silencieusement si plusieurs instances du même plugin lisent et écrivent activement des données.Si votre plugin s'attend à écrire souvent dans les paramètres, vous pouvez vérifier que les données ont été écrites correctement en appelant Plugin:GetSetting() .

Paramètres

Retours

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

Démarrer le glisser lance une action de glissement en utilisant un dictionnaire de paramètres. Les paramètres sont les suivants :

<th>Type</th>

    <th>Par défaut</th>

    <th>Avertissement</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><b>Expéditeur</b></td><td>chaîne</td><td><code>""</code></td>

    <td>
      Identifie la source de l'action de glisser vers la cible de dépose
    </td>
  </tr>

  <tr>
    <td><b>Type de mime</b></td><td>chaîne</td><td><code>""</code> ></td>

    <td>
      Le type <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME</a> de <b>données</b>.
    </td>
  </tr>

  <tr>
    <td><b>Données</b></td><td>chaîne</td><td><code>""</code> ></td>

    <td>
      Informations sur l'action de glisser, par exemple ce qui est glissé. Doit être utilisé par la cible de dépose.
    </td>
  </tr>

  <tr>
    <td><b>Icône de souris</b></td><td><code>Type de données.Contenu</code> ></td><td><code>""</code> ></td>

    <td>
      L'icône à utiliser pour le curseur de la souris pendant le glisser. S'il est vide, utilise le curseur par défaut.
    </td>
  </tr>

  <tr>
    <td><b>DragIcon</b></td><td><code>Type de données.Contenu</code> ></td><td><code>""</code> ></td>

    <td>
      Une image à rendre sous le curseur de la souris pendant le glissement. Cela devrait représenter l'élément qui est glissé.
    </td>
  </tr>

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

    <td>
      Le décalage des pixels à partir du haut à gauche où le curseur devrait "maintenir" le <b>DragIcon</b> .
    </td>
  </tr>
</tbody>

Voir aussi :

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

Paramètres

Retours

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)

Unionne les parties données et renvoie l'opération d'union résultante.

Paramètres

Retours

CreateDockWidgetPluginGui crée une nouvelle DockWidgetPluginGui à partir du donné DockWidgetPluginGuiInfo.Le premier paramètre, pluginGuiId , doit être une chaîne unique et cohérente.Il est utilisé pour enregistrer l'état du dock d'un widget et d'autres détails internes.

Paramètres

Retours

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

Cette fonction invite l'utilisateur à ouvrir un fichier d'animation .fbx qui peut être chargé sur le rigModel , puis procède à l'insertion de l'animation comme une KeyframeSequence dans le Workspace .

Paramètres

Retours

Invite l'utilisateur à ouvrir un fichier .fbx, télécharge les composants individuels du modèle en tant que maillages et génère un chariot de personnage pour l'utilisation dans l'animations, qui est chargé dans le Workspace .

Paramètres

Retours

Ouvre une fenêtre dans Roblox Studio, qui invite l'utilisateur à sélectionner une ressource en fonction de la assetType spécifiée.Renvoie l'ID de ressource sélectionné, ou -1 si la fenêtre a été fermée.

Paramètres

Retours

Invite l'utilisateur à enregistrer sa sélection actuelle avec le nom de fichier spécifié. Renvoie true si l'utilisateur a enregistré le fichier.

Paramètres

Retours

Tiré lorsque le Plugin est désactivé.Cela se produit lorsque le code du plugin appelle Plugin:Deactivate() ou parce que quelque autre plugin a appelé Plugin:Activate(), ce qui force tous les autres plugins à perdre leur état actif.

Voir aussi :

• Plugin.Unloading , se déclenche immédiatement avant que le plugin ne soit déchargé ou rechargé via désactivation, désinstallation ou mise à jour

Cet événement se déclenche immédiatement avant que les Plugin arrêts de fonctionnement ne s'arrêtent.Les plugins sont déschargés lorsqu'ils sont désactivés, désinstallés, sur le point d'être mis à jour ou lorsque l'endroit ferme.

Il permet à un plugin de nettoyer après lui-même avant que ses scripts cessent de s'exécuter, par exemplepour supprimer les instances inutiles de la DataModel .Si un plugin ne se nettoie pas correctement, les anciennes copies resteront.Lorsque cela se produit, les utilisateurs peuvent être obligés de fermer et de rouvrir l'endroit qui est une mauvaise expérience utilisateur.

Les instances liées aux plugins telles que PluginToolbarButtons , DockWidgetPluginGuis et PluginGuis sont automatiquement nettoyées lorsque le plugin est déchargé, il n'est donc pas nécessaire de les supprimer.