Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

DragAndDrop.StartDrag

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function StartDrag(title: string): void;
public static void StartDrag(string title);

Description

Start a drag operation.

Initiates a drag operation with the current drag object state. Use paths and/or objectReferences to setup drag state.

See Also: PrepareStartDrag, paths, objectReferences.

    function OnGUI () {
        if (Event.current.type == EventType.MouseDrag) {
            // Clear out drag data
            DragAndDrop.PrepareStartDrag ();

// Set up what we want to drag DragAndDrop.paths = [ "/Users/joe/myPath.txt" ];

// Start the actual drag DragAndDrop.StartDrag ("Dragging title");

// Make sure no one uses the event after us Event.current.Use(); } }