Unity Attribute学习总结

秒速五厘米 2022-06-05 07:16 182阅读 0赞

1.  在变量上使用\[SerializeField\]属性，可以强制对该变量进行序列化，即可以在Editor模式对变量进行赋值（即使是private类型也可以）。

public class serializeField : MonoBehaviour {
        [SerializeField]
        private string id;
    }

![这里写图片描述][SouthEast]  
2. 在class上使用\[RequireComponent\]属性，则在class所挂载的GameObject上会自动追加所需要的Component

[RequireComponent(typeof(Rigidbody))]
    public class requireComponent : MonoBehaviour {}

![这里写图片描述][SouthEast 1]  
3. \[ContextMenu\]属性，可以在挂载了该类的Inspector面板中执行相应的方法。

public class contextMenu : MonoBehaviour {
        [ContextMenu("Do Something")]
        void DoSomething()
        {
            Debug.Log("Perform operation");
        }
    }

![这里写图片描述][SouthEast 2]  
4. \[ContextMenuItem\]属性，可以在挂载了该类的Inspector面板对某变量添加一个右键菜单并指定执行相应的方法。

public class contextMenuItem : MonoBehaviour {
        [ContextMenuItem("Reset", "ResetName")]
        public new string name = "Name";
        public string password = "Password";
        void ResetName() {
            name = "Name";
        }
    }

![这里写图片描述][SouthEast 3]  
5. 在静态方法上添加\[MenuItem\]属性。可以在Editor中创建一个菜单项，点击后执行该方法。多级菜单用“/”分隔。

public class menuItem : MonoBehaviour {
        [MenuItem("MenuItem/Create GameObject")]
        public static void CreateGameObject() {
            new GameObject("new A GameObject");
        }
    }

![这里写图片描述][SouthEast 4]  
![这里写图片描述][SouthEast 5]  
6. \[AddComponentMenu\]属性，可以在UnityEditor的Component的Menu中添加自定义的功能。菜单是多级时使用“/”分隔。

[AddComponentMenu("AddMenu/AddConponent")]
    public class addComponentMenu : MonoBehaviour {}

![这里写图片描述][SouthEast 6]  
![这里写图片描述][SouthEast 7]  
![这里写图片描述][SouthEast 8]  
7. 在class上使用\[DisallowMultipleComponent\]属性，在同一个GameObject对象上只能添加该类的一个实例。

[DisallowMultipleComponent]
    public class disallowMultipleConponent : MonoBehaviour {}

![这里写图片描述][SouthEast 9]  
8. \[Header\]属性，在Inspector面板显示数据

public class header : MonoBehaviour {
        [Header("生命值")]
        public int CurrentHP = 0;
        public int MaxHP = 100;
        [Header("魔法值")]
        public int CurrentMP = 0;
        public int MaxMP = 100;
    }

![这里写图片描述][SouthEast 10]  
9. 默认状态下class的Start、Update、OnGUI等方法需要在Play状态下才会被执行，但在class中添加\[ExecuteInEditMode\]属性后，这些方法在Editor模式也能执行。Update方法只有在Scene面板中物体变化时才会被调用；OnGUI方法只有在GameView接收到事件时才会被调用。

[ExecuteInEditMode]
    public class executeInEditMode : MonoBehaviour {
        void Update () {
            Debug.Log(this.transform.position);
        }
    }

![这里写图片描述][SouthEast 11]  
10. 在public类型的变量上添加\[HideInInspector\]属性，则在Inspector面板上不会显示该变量。

public class hideInInspector : MonoBehaviour {
        [HideInInspector]
        public new string name;
        public string password;
    }

![这里写图片描述][SouthEast 12]  
11. 在OnRenderImage上使用\[ImageEffectOpaque\]属性可以让渲染顺序在非透明之后、透明物体之前。

public class imageEffectOpaque : MonoBehaviour {
        [ImageEffectOpaque]
        void OnRenderImage(RenderTexture source, RenderTexture destination) {}
    }

1.  在string类型上使用\[MultillineAttribute\]属性，可以在Editor上输入多行文字。

public class multilineAttribute : MonoBehaviour {
        [MultilineAttribute]
        public string mText;
    }

![这里写图片描述][SouthEast 13]  
13. 在int或float上使用\[Range\]属性可以限制输入值的范围

public class range : MonoBehaviour {
        [Range(0, 100)]
        public float HP;
    }

![这里写图片描述][SouthEast 14]  
14. 在静态方法上使用\[RuntimeInitializeOnLoadMethod\]属性，在运行时会自动调用添加该属性的方法。

public class runtimeInitializeOnLoadMethod : MonoBehaviour {
        [RuntimeInitializeOnLoadMethod]
        static void OnRuntimeMethodLoad() {
            Debug.Log("Game load and is running");
        }
    }

![这里写图片描述][SouthEast 15]  
15. 使用\[Space\]属性可以在Inspector面板添加一些空位。

public class space : MonoBehaviour {
        public int nospace1 = 0;
        public int nospace2 = 0;
        [Space(10)]
        public int space1 = 0;
        public int nospace3 = 0;
    }

![这里写图片描述][SouthEast 16]  
16. 在string上使用\[TextArea\]属性可以将变量在Inspector面板上的编辑区变成TextArea。

public class textArea : MonoBehaviour {
        [TextArea]
        public string mText;
    }

![这里写图片描述][SouthEast 17]  
17. 在变量上使用\[Tooltip\]属性，当鼠标移动到该变量上时提示信息。

public class tooltip : MonoBehaviour {
        [Tooltip("This year is 2017!")]
        public int yaer = 0;
    }

![这里写图片描述][SouthEast 18]  
18. 在变量上添加\[FormerlySerializedAs\]属性，可以令变量以另外的名称进行序列化，并且在变量自身修改名称时不会丢失之前的序列化的值。

public class formerlySerializedAs : MonoBehaviour {
        [FormerlySerializedAs("myValue")]
        private string m_MyValue;
        public string myValue {
            get {
                return m_MyValue;
            }
            set {
                m_MyValue = value;
            }
        }
    }

1.  在class上添加\[CustomPreview\]属性，将该class标记为指定类型的自定义预览。

[CustomPreview(typeof(GameObject))]
    public class customPreview : ObjectPreview {
        public override bool HasPreviewGUI()
        {
            return true;
        }
        public override void OnPreviewGUI(Rect r, GUIStyle background)
        {
            GUI.Label(r, target.name + "is being previewed");
        }
    }

1.  在class上添加\[InitializeOnLoad\]属性，在Play模式下自动执行静态构造函数，无需实例。

[InitializeOnLoad]
    public class initializeOnLoad : MonoBehaviour {
        static initializeOnLoad() {
            EditorApplication.update += Update;
            Debug.Log("Up and running");
        }
        static void Update() {
            Debug.Log("Updating");
        }
    }

1.  使用\[PreferenceItem\]属性自定义Preference界面。

public class preferenceItem {
        private static bool prefsLoaded = false;
        public static bool boolPreference = false;
        //添加一个名为"My Preference"到Preferences Window
        [PreferenceItem("My Preference")]
        public static void PreferencesGUI() {
            //Load the preference
            if (!prefsLoaded) {
                boolPreference = EditorPrefs.GetBool("BoolPreferenceKey", false);
                prefsLoaded = true;
            }
            //Preferences GUI
            boolPreference = EditorGUILayout.Toggle("Bool Preference", boolPreference);
            //Save the preference
            if (GUI.changed)
                EditorPrefs.SetBool("BoolPreferenceKey", boolPreference);
        }
    }

![这里写图片描述][SouthEast 19]  
22. 在打开一个Asset后被调用

public class assetHandler {
        [OnOpenAsset(1)]
        public static bool step1(int instanceID, int line) {
            string name = EditorUtility.InstanceIDToObject(instanceID).name;
            Debug.Log("Open Asset step: 1 (" + name + ")");
            return false;
        }
        [OnOpenAsset(2)]
        public static bool step2(int instanceID, int line) {
            Debug.Log("Open Asset step: 2 (" + instanceID + ")");
            return false;
        }
    }

1.  在静态方法中添加\[PostProcessBuild\]属性，该方法会在Build后被调用。在静态方法中添加\[PostProcessScene\]属性，该方法会在Build前被调用。

public class postProcess : MonoBehaviour {
        [PostProcessBuild(1)]
        public static void OnPostProcessBuild(BuildTarget target, string pathToBuildProject) {
            Debug.Log("PostProcessBuild");
            Debug.Log(target);
            Debug.Log(pathToBuildProject);
        }
        [PostProcessScene(1)]
        public static void OnPostProcessScene()
        {
            Debug.Log("PostProcessScene");
        }
    }

> 参考资料：[https://mp.weixin.qq.com/s/wSt6fEzmIlevYCj-26LoEg][https_mp.weixin.qq.com_s_wSt6fEzmIlevYCj-26LoEg]

[SouthEast]: /images/20220605/ecca63da2841454b93f2409877b0b053.png
[SouthEast 1]: /images/20220605/40fe50c4661b4bab8af69c6f892c418d.png
[SouthEast 2]: /images/20220605/33cb010b7fcc43389400c20751c41e9a.png
[SouthEast 3]: /images/20220605/7b6a95dc60ae43cabb4a41c87dc40c70.png
[SouthEast 4]: /images/20220605/13a2b865ba784a119aec66484e0cd471.png
[SouthEast 5]: /images/20220605/2d1d94a4be614d40adecd52760f7e989.png
[SouthEast 6]: /images/20220605/43e357269b434cbd90b8c780264488f2.png
[SouthEast 7]: /images/20220605/a9bd0b92811743bda088fec4dbead84b.png
[SouthEast 8]: /images/20220605/d04e187495e249eebe30b0a96cc18835.png
[SouthEast 9]: /images/20220605/c69b728183424ce4b20948f99daedeee.png
[SouthEast 10]: /images/20220605/f535f868bfdf4c8e9b49b94807cd2a7e.png
[SouthEast 11]: /images/20220605/593aa716cac543de940a97f5de938397.png
[SouthEast 12]: /images/20220605/294fc5c0123d48eca433cbf1bd073457.png
[SouthEast 13]: /images/20220605/a4d830aca76e44e1b9fb786ca3a5970a.png
[SouthEast 14]: /images/20220605/7371d67c739c4029947e5d80a66a6862.png
[SouthEast 15]: /images/20220605/55ff884cf5e643798b1453f39ffd3d96.png
[SouthEast 16]: /images/20220605/28b355a13c5f438ba734db6b845afa68.png
[SouthEast 17]: /images/20220605/e32589773c25462d98aac8b2757c57bd.png
[SouthEast 18]: /images/20220605/7f676ab42d6b487388c5952198944808.png
[SouthEast 19]: /images/20220605/9641f8b3b9e44b23a447ba57b68fcf25.png
[https_mp.weixin.qq.com_s_wSt6fEzmIlevYCj-26LoEg]: https://mp.weixin.qq.com/s/wSt6fEzmIlevYCj-26LoEg