Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PluginDragEvent

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

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 4

HistoryMember
731Data: string
731MimeType: string
731Position: Vector2
731Sender: string
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

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.

History 25

Members 4

Data

TypeDefault
string

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

  • 731 Change Default of Data from to
  • 726 Change Default of Data from to
  • 553 Change Default of Data from to
  • 486 Change ThreadSafety of Data from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Data from to ReadOnly
  • 354 Add Data
Tags: [ReadOnly, NotReplicated]

MimeType

TypeDefault
string

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated]

Position

TypeDefault
Vector2

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated]

Sender

TypeDefault
string

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated]

Settings