Roblox UtilitiesDevlHub Roblox Documentation

Class

PluginDragEvent

NotCreatableNotReplicated
Inherits
Instance › Object
Memory category
Instances

Provides information about an in-progress drag for the drag events that plugins can respond to.

PluginDragEvent provides information about a drag-and-drop operation that a plugin can respond to. An instance of it is passed as the argument to the PluginGui drag events (PluginGui.PluginDragEntered, PluginGui.PluginDragMoved, PluginGui.PluginDragLeft, and PluginGui.PluginDragDropped) which fire as a drag started with Plugin:StartDrag() moves over, into, out of, or is released on a plugin widget.

It carries the Sender, MimeType, and Data originally supplied to Plugin:StartDrag(), along with the Position of the cursor within the widget receiving the drag.

Properties 4#

DatastringThe data payload being transferred by the drag.ReadSafeReadOnlyNotReplicated
MimeTypestringThe MIME type describing the format of the dragged data, such as text/plain.ReadSafeReadOnlyNotReplicated
PositionVector2The position of the drag relative to the widget receiving it.ReadSafeReadOnlyNotReplicated
SenderstringA caller-defined string identifying the source of the drag.ReadSafeReadOnlyNotReplicated

Data: string#

ReadOnlyNotReplicatedReadSafe

The data being transferred by the drag, corresponding to the Data value passed to Plugin:StartDrag() when the drag began. This property is read-only and defaults to an empty string.

MimeType: string#

ReadOnlyNotReplicatedReadSafe

Identifies the format of PluginDragEvent.Data, corresponding to the MimeType value passed to Plugin:StartDrag() when the drag began. This property is read-only and defaults to an empty string.

Position: Vector2#

ReadOnlyNotReplicatedReadSafe

The position, in pixels, of the mouse cursor relative to the PluginGui widget receiving the drag, updated as the drag moves. This property is read-only and defaults to (0, 0).

Sender: string#

ReadOnlyNotReplicatedReadSafe

A caller-defined string used to identify where the drag originated, corresponding to the Sender value passed to Plugin:StartDrag() when the drag began. This property is read-only and defaults to an empty string.

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed