EditorGUI.AttachToPlayerDropdown

Parameters

Description

Display a drop-down button and menu for the user to choose and establish a connection to a Player.

This is the same control that is used in the toolbars of the Profiler Window, Frame Debugger or Console Window. The drop-down will list all available Players and Editors that your Editor can connect to and that are discoverable. It also offers an entry to directly connect to an IP address. You will need to provide the state of the connection used for your EditorWindow. To get one, use EditorGUIUtility.GetAttachToPlayerState in OnEnable and remember to dispose of the state in OnDisable of the EditorWindow you're using it in.

This class is experimental because it currently only works for the connection that the Profiling tools and the Console use. In a future release this will work with PlayerConnection.

using UnityEngine;
using UnityEngine.Profiling;
using UnityEditor;
using UnityEngine.Experimental.Networking.PlayerConnection;
using PlayerConnectionGUI = UnityEditor.Experimental.Networking.PlayerConnection.EditorGUI;
using PlayerConnectionGUIUtility = UnityEditor.Experimental.Networking.PlayerConnection.EditorGUIUtility;

public class MyWindow : EditorWindow
{
    // The state can survive for the life time of the EditorWindow so it's best to store it here and just renew/dispose of it in OnEnable and OnDisable, rather than fetching repeatedly it in OnGUI.
    IConnectionState attachProfilerState;

    [MenuItem("Window/My Window")]
    static void Init()
    {
        MyWindow window = (MyWindow)GetWindow(typeof(MyWindow));
        window.Show();
    }

    private void OnEnable()
    {
        // The state of the connection is not getting serialized and needs to be disposed
        // Therefore, it's recommended to fetch it in OnEnable and call Dispose() on it in OnDisable
        attachProfilerState = PlayerConnectionGUIUtility.GetAttachToPlayerState(this, OnConnected);
    }

    private void OnConnected(string player)
    {
        Debug.Log(string.Format("MyWindow connected to {0}", player));
    }

    private void OnGUI()
    {
        // Draw a toolbar across the top of the window and draw the drop-down in the toolbar drop-down style too
        EditorGUILayout.BeginHorizontal(EditorStyles.toolbar);
        var rect = GUILayoutUtility.GetRect(100, EditorGUIUtility.singleLineHeight, EditorStyles.toolbarDropDown);
        PlayerConnectionGUI.AttachToPlayerDropdown(rect, attachProfilerState, EditorStyles.toolbarDropDown);

        switch (attachProfilerState.connectedToTarget)
        {
            case ConnectionTarget.None:
                //This case can never happen within the Editor, since the Editor will always fall back onto a connection to itself.
                break;
            case ConnectionTarget.Player:
                Profiler.enabled = GUILayout.Toggle(Profiler.enabled, string.Format("Profile the attached Player ({0})", attachProfilerState.connectionName), EditorStyles.toolbarButton);
                break;
            case ConnectionTarget.Editor:
                // The name of the Editor or the PlayMode Player would be "Editor" so adding the connectionName here would not add anything.
                Profiler.enabled = GUILayout.Toggle(Profiler.enabled, "Profile the Player in the Editor", EditorStyles.toolbarButton);
                break;
            default:
                break;
        }
        EditorGUILayout.EndHorizontal();
    }

    private void OnDisable()
    {
        // Remember to always dispose of the state!
        attachProfilerState.Dispose();
    }
}

Also see EditorGUI.AttachToPlayerDropdown for automatic layouts as well as EditorGUIUtility.GetAttachToPlayerState and IConnectionState for details of the state handling for this UI control.