EditorGUIUtility.GetAttachToPlayerState

パラメーター

戻り値

IConnectionState The not serialized state of the connection to a Player, to be used in EditorGUI.AttachToPlayerDropdown or EditorGUILayout.AttachToPlayerDropdown. It knows what target is currently connected and what targets are available.

説明

This method generates a state tracking object for establishing and displaying an Editor to Player Connection.

This state and the corresponding GUI Methods (EditorGUI.AttachToPlayerDropdown and EditorGUILayout.AttachToPlayerDropdown) are supposed to be used from within an EditorWindow. The supplied Editor Window is used to: 1. Display an overlay while connecting 2. Repaint the window after a connection has been established 3. Receive callback calls through connectedCallback when other windows using the same connection type establish a connection Technically, it might be possible to supply parentWindow as null and use it outside of EditorWindow, but that is neither recommended nor a use-case we plan to support.

Also keep in mind that the received state is not serialized and needs to be disposed. The recommended use pattern is to get the state in the EditorWindow's OnEnable and to dispose of it in OnDisable.

The connectedCallback will not be fired if, for example, the connection was made by automatically establishing a profiler connection to a Player or falling back on to the connection to the Editor. Instead, it only responds to a user actively choosing a target, and waits until that connection has been established. If the connection type is one that is shared across Editor windows, it will also be fired when the user chooses it in a different EditorWindow.

The returned state knows what target is currently connected and what targets are available.

using UnityEngine;
using UnityEngine.Profiling;
using UnityEditor;
using UnityEngine.Experimental.Networking.PlayerConnection;
using PlayerConnectionGUILayout = UnityEditor.Experimental.Networking.PlayerConnection.EditorGUILayout;
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);
        PlayerConnectionGUILayout.AttachToPlayerDropdown(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 the state!
        attachProfilerState.Dispose();
    }
}