【Unity笔记】编辑器扩展基础篇

扩展

• 检视器扩展开发inspector
• 顶部菜单栏
• 弹窗
• 场景编辑器，编辑器主场景页面

特殊目录

• 多目录会自动合并，都是特殊目录
• 重名会被覆盖
• 游戏逻辑中不能带有UnityEditor中，否则会打包错误

检视器

扩展1 不属于Editor的

/****************************************************
    文件：SimpleInspector.cs
	作者：别离或雪
    邮箱: [email protected]
    日期：#CreateTime#
	功能：编辑器扩展，Inspectors
*****************************************************/

using System;
using System.Collections.Generic;
using UnityEngine;

/// 

/// 如果对象不标记为可序列化的，则unity存储时，认为他不可序列化
/// 也就不会被显示，uniy内置Json工具原理也是类似
/// 
[Serializable]
public class Numberical {
    public float Atk;
    public float Def;
}
//职业枚举
public enum Profression {
    Warrior=0,
    Wizard,
}

public class SimpleInspector : MonoBehaviour 
{
    /// 

    /// 隐藏公共成员变量，不显示，防止inspector影响
    /// 
    [HideInInspector]
    public int ID;

    /// 

    /// 显示私有，序列化，（json中）成一个字符串
    /// Unity中自称体系的结构，也可以序列化，是否可存储
    /// Unity会将对象进行序列化存储，公有默认是可序列化的
    /// 
    [SerializeField]
    private string ShowID;

    /// 

    /// 显示对象
    /// 
    public Numberical Num;
    
    //当前成员变量上方留50距离
    [Space(50)]
    //添加变量悬浮提示文字
    //一个变量可以添加多个特性
    [Header("年龄")]
    [Tooltip("不要填写大约150的年龄")]
    /// 

    /// 设置数值设定范围
    /// 
    [Range(0,150)]
    public int Age;

    //指定输入框，有5行
    [Multiline(5)]
    public string NickName;

    //默认显示5行，再多8行，更多滚动条
    [TextArea(5,8)]
    public string Decripttion;

    
    public Color Flag;

    public Texture Tex;

    public List<string> Tags;

    public Profression Pro;

    //小齿轮增加一个回调函数
    [ContextMenu("输出攻防比")]
    public void PrintADProportion() {
        Debug.Log("攻防比："+Num.Atk/Num.Def);
    }

    //给成员变量添加右键菜单，第一个菜单名称，第二个右键点击的回调函数
    [ContextMenuItem("输出国家", "OutCountry")]
    [Tooltip("右键看看")]
    public string Country;

    public void OutCountry() {
        Debug.Log(Country);
    }
}

扩展2 显示开发

/****************************************************
    文件：Player.cs
	作者：别离或雪
    邮箱: [email protected]
    日期：#CreateTime#
	功能：Player
*****************************************************/

using System.Collections.Generic;
using UnityEngine;
//单选用10进制，不同数不同选项
public enum PlayerProfression {
    Warrior = 0,
    Wizard=1,
}
//多选用二进制，不同位代表不同选项
public enum PlayerLoveColor {
    Green=1,
    Red=2,
    Pink=4,
    //
}

//将pLayer组件添加到AddComponent上
//第一个参数：“分类名/组件名”，第二个参数：组件显示顺序
[AddComponentMenu("自定义控制器/玩家控制器",1)]
//编辑模式下运行，使生命周期函数再编辑器状态下可以执行，游戏中也可以正常使用
//对项目进行编辑或项目组织发生变化时调用。
[ExecuteInEditMode]
//关于类型和类名
//BoxCollider：是类名，适用于函数提供的泛型方法
//typeof(BoxCollider):System.Type C#的类型，适用于System.Type参数

//当前组件依赖碰撞器
//当前组件挂在对象上时，碰撞器一起添加
//当Player组件没有被移出时，盒子碰撞器不能删除
//typeof是类型，而不是类名，泛型要的是类名
[RequireComponent(typeof(BoxCollider))]
public class Player : MonoBehaviour 
{
    public int ID;

    public string Name;

    public float Atk;

    public bool isMan;

    public Vector3 HeadDir;

    public Color Hair;

    public GameObject Weapon;
    
    public Texture Cloth;

    public PlayerProfression Pro;
    public PlayerLoveColor LoveColor;

    public List<string> Items;

    private void Update() {
        Debug.Log("Update");
    }
}

• 检视器高级修改，外挂式编程
• Editor目录下建立外挂式开发脚本
• 将编辑器脚本，与原始脚本关联

/****************************************************
    文件：PlayerEditor.cs
	作者：别离或雪
    邮箱: [email protected]
    日期：#CreateTime#
	功能：外挂式编辑
*****************************************************/

//步骤一： 需要引入编辑器命名空间，检视器属于编辑器开发范畴
using UnityEditor;
using UnityEngine;

//步骤三：编辑器开发脚本，与需要编辑的脚本组件建立关联
[CustomEditor(typeof(Player))]
//外挂脚本存储再Editor目录下，不会被打入包内
//不继承Mono，而是继承Editro
public class PlayerEditor : Editor//步骤二：继承Eidtor 
{
    //获得需要编辑显示的组件
    private Player _Component;

    //步骤四：在当前外挂脚本中获得需要被扩展的Player组件对象
    //关联组件所在对象被选中和添加时，调用
    
    private void OnEnable() {
        // Debug.Log("Enable");
        //步骤五：获取Player对象
        _Component = target as Player;
    }
    //关联组件所在对象被取消和移出时，调用
    private void OnDisable() {
        //Debug.Log("DisEnable");
        _Component = null;
    }

    /// 

    /// 用于绘制检视面版的生命周期函数
    /// 
    public override void OnInspectorGUI() {
        //base.OnInspectorGUI();
        //标题显示
        EditorGUILayout.LabelField("人物相关属性");
        
        //自定义显示，名字，对应的字段
        //取完再放回去才行，才能修改。
        _Component.ID=EditorGUILayout.IntField("玩家ID",_Component.ID);
        //颜色
        _Component.Hair = EditorGUILayout.ColorField("头发颜色", _Component.Hair);
        //String
        _Component.Name = EditorGUILayout.TextField("玩家名字", _Component.Name);
        //Bool
        _Component.isMan = EditorGUILayout.Toggle("是否位男性", _Component.isMan);
        //Vector
        _Component.HeadDir = EditorGUILayout.Vector3Field("头发方向", _Component.HeadDir);
        //Float
        _Component.Atk = EditorGUILayout.FloatField("攻击力", _Component.Atk);

        //复杂数据类型
        //Texture,GameObject
        //参数1：标题
        //参数2：原始组件值
        //参数3：成员变量类型
        //参数4：是否可以赋值（拖拽）
        _Component.Weapon = EditorGUILayout.ObjectField("持有武器", _Component.Weapon, typeof
            (GameObject),true)as GameObject;
        _Component.Cloth = EditorGUILayout.ObjectField("衣服材质贴图", _Component.Cloth, typeof
            (Texture), false) as Texture;

        //单选枚举
        _Component.Pro = (PlayerProfression)EditorGUILayout.EnumPopup("玩家职业", _Component.Pro);
        //多选枚举
        _Component.LoveColor = (PlayerLoveColor)EditorGUILayout.EnumFlagsField("玩家喜欢的颜色",
            _Component.LoveColor);

        //终极数据类型绘制
        //更新可序列化信息
        serializedObject.Update();
        //通过成员变量名找到组件上成员变量
        SerializedProperty sp = serializedObject.FindProperty("Items");
        //可序列化数据绘制，收到数据，标题，是否将收集的序列化信息显示出啦
        EditorGUILayout.PropertyField(sp, new GUIContent("道具信息"), true);
        //将修改完的数据，写入序列化的原始数据中
        serializedObject.ApplyModifiedProperties();

        //滑动条
        _Component.Atk = EditorGUILayout.Slider(new GUIContent("玩家攻击力"), _Component.Atk, 0,100);
        if (_Component.Atk > 80) {
            EditorGUILayout.HelpBox("攻击力太高了", MessageType.Error);
        }
        if (_Component.Atk < 20) {
            EditorGUILayout.HelpBox("攻击力太低了", MessageType.Warning);
        }

        //按钮绘制
        GUILayout.Button("来个按钮");
        GUILayout.Button("来个按钮");
        //开始横向排序
        EditorGUILayout.BeginHorizontal();
        GUILayout.Button("来个按钮");
        GUILayout.Button("来个按钮");
        //结束横向排序
        EditorGUILayout.EndHorizontal();

        //按下按钮
        if (GUILayout.Button("测试点击")) {
            Debug.Log("测试点击");
        }
    }
}

顶部菜单

顶部菜单

/****************************************************
    文件：Menu.cs
	作者：别离或雪
    邮箱: [email protected]
    日期：#CreateTime#
	功能：菜单
*****************************************************/

using UnityEngine;
using UnityEditor;
public class Menu  
{
    //再顶部显示“工具菜单”,下方有“导出AB资源包”,点击执行函数
    [MenuItem("工具/导出AB资源包")]
    static void BuildAB() {
        Debug.Log("导出AB资源包");
        Debug.Log(Application.persistentDataPath);
    }
}

窗口

/****************************************************
    文件：PopWindow.cs
	作者：别离或雪
    邮箱: [email protected]
    日期：#CreateTime#
	功能：弹窗
*****************************************************/

using UnityEngine;
using UnityEditor;

//继承EditorWindow
public class PopWindow : EditorWindow 
{
    [MenuItem("工具/创建窗口")]
    static void OpenWindow() {
        //创建窗口
        //是否是特殊窗口（单独出现），标题，是否立刻获得焦点，
        PopWindow window= GetWindow<PopWindow>(false,"弹窗",true);
        //最大最小值
        window.minSize = new Vector2(400, 300);
        window.maxSize = new Vector2(800, 600);
    }

    //窗口生命周期函数
    //开启窗口调用
    private void OnEnable() {
        Debug.Log("Enable");
    }
    //关闭窗口
    private void OnDisable() {
        Debug.Log("DisEnable");
    }
    //窗口开启就调用
    private void Update() {
        Debug.Log("Update");

    }
    private void OnGUI() {
        //按钮绘制
        GUILayout.Button("来个按钮");
        GUILayout.Button("来个按钮");
        //开始横向排序
        EditorGUILayout.BeginHorizontal();
        GUILayout.Button("来个按钮");
        GUILayout.Button("来个按钮");
        //结束横向排序
        EditorGUILayout.EndHorizontal();

        //按下按钮
        if (GUILayout.Button("测试点击")) {
            Debug.Log("测试点击");
        }
    }

    //场景发生变化
    private void OnHierarchyChange() {
        Debug.Log("HierarchyChange");
    }
    //项目发生变化
    private void OnProjectChange() {
        Debug.Log("ProjectChange");
    }
    //选中物体发生变化
    private void OnSelectionChange() {
        //获取当前选中物体名称
        Debug.Log(Selection.activeGameObject.name);
    }
}

场景视窗扩展

• 脚本挂在物体上
• 扩展外挂式编程
• 窗口持续位选择状态

• 绘制组件生命周期函数

• 编辑器状态下，从编辑器GUI界面发射线，而不是摄像机
• 必须开启窗口，不然界面直接切换到新建物体上，编辑停止

• 打开窗口，持续把板子作为选中状态