编辑器扩展基础3-自定义PropertyDrawer

介绍

自定义Unity组件时如果不加以控制,会按照Unity默认的方式来排布显示可序列化属性。

如果我们向让属性显示得更个性化一些,可以自定义PropertyDrawer。

这个PropertyDrawer它可以指定Serializable类(可序列化类)或PropertyAttribute(自定义属性),这样就有了两种使用:

  • 为每个Serializable实例绘制GUI
  • 为自定义属性的每个元素绘制GUI

另注
组件为什么能显示在Inspector面板上?
因为组件都继承自Monobehaviour,父类的initiate方法起到了序列化和反序列化的作用。这样就能保存为MetaData,供下次使用。

Serializable类(可序列化类)在Unity中有什么含义呢?
默认地,Unity只给自定义的公有变量、继承自MonoBehaviour的类执行序列化,所以如果想让一个类序列化,那么就要指定[Serializable]标签。它将MetaData放入可以通过反射重新获取并由Unity使用的类中。有了这个Unity知道它应该/可以序列化类。

Unity序列化的关键字是 Serializable 和 SerializeField,具体描述可以翻阅api。

案例1-将Serializable类的属性按照一定排布方式显示出来

假设我们在写一个组件需要把一个引用字段里的属性都显示出来供配置,那么,根据上面的介绍我们要分两步。

  • 实现可序列化类
  • 实现对应的PropertyDrawer(放在Editor目录下)
  • 组件调用
public enum IngredientUnit { Spoon, Cup, Bowl, Piece }

[Serializable]
public class Ingredient
{
    public string name;
    public int amount = 1;
    public IngredientUnit unit;
}
using UnityEditor;
using UnityEngine;

//给Ingredient指定PropertyDrawer
[CustomPropertyDrawer(typeof(Ingredient))]
public class IngredientDrawer:PropertyDrawer{
    //在给定的Rect区域中绘制属性
    public override void OnGUI(Rect position,SerializedProperty property,GUIContent label){
        //重载BeginProperty
        EditorGUI.BeginProperty(position,label,property);  

        //绘制标签
        position = EditorGUI.PrefixLabel(position,GUIUtility.GetControlID(FocusType.Passive),label);
        
        //Unity默认的每个属性字段都会占用一行,我们这里希望一条自定义Property占一行
        //要是实现这个要求我们分三步: 1. 取消缩进  2. 设置PropertyField 3.还原缩进
        
        //不要缩进子字段,只有取消了缩进,Rect挤才一行才不会混乱
        var indent = EditorGUI.indentLevel;
        EditorGUI.indentLevel = 0;

        //计算要用到的属性显示rect   Rect(x,y,width,height)x,y是左顶点
        var amountRect = new Rect(position.x,position.y,30,position.height);
        var unitRect = new Rect(position.x + 35,position.y,50,position.height);
        var nameRect = new Rect(position.x + 90,position.y,position.width  -  90,position.height);

        //绘制字段 - 将GUIContent.none传递给每个字段,以便绘制它们而不是用标签
        //属性绘制器不支持布局来创建GUI;
        //因此,您必须使用的类是EditorGUI而不是EditorGUILayout。这就是为什么要给每个属性指定Rect
        EditorGUI.PropertyField(amountRect,property.FindPropertyRelative("amount"),GUIContent.none);
        EditorGUI.PropertyField(unitRect,property.FindPropertyRelative("unit"),GUIContent.none);
        EditorGUI.PropertyField(nameRect,property.FindPropertyRelative("name"),GUIContent.none);

        //将缩进还原,好习惯
        EditorGUI.indentLevel = indent;

        EditorGUI.EndProperty();
    }
}
public class Recipe : MonoBehaviour
{
    public Ingredient potionResult;
    public Ingredient[] potionIngredients;
    public Vector2 ff = Vector2.zero;
}

前文链接:自定义menuItem
下文:针对自定义特性创建PropertyDrawer

注:配套案例可在EditorExtensionDemo仓库中查看。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容

  • 一、Unity简介 1. Unity界面 Shift + Space : 放大界面 Scene界面按钮渲染模式2D...
    MYves阅读 8,174评论 0 22
  • 前言:编辑器扩展部分在开发调试过程中会非常有帮助,基本上每个项目都会涉及到自定义Editor Window和Ins...
    地坛公园阅读 1,859评论 0 3
  • 金融的世界,就是一个哈哈镜,在这里,与现实完全不一样
    今古醉仙人阅读 78评论 0 0
  • 2017年12月30日,我和宁正如~唐晓清三个人一起提前录了2018年的❤️祝福。 我给自己的新年愿望是我希望自己...
    GM一阅读 149评论 0 0
  • 婚礼是人生的幸福时刻,戒指见证海誓山盟,当灾难来临时,灾情就是命令,新郎义无反顾地走到了前线,让新娘过上了刻骨...
    郭相麟阅读 228评论 0 0