Unity教程之-Unity Attribute的使用總結

舉兩個例子，在變量上使用[SerializeFiled]屬性，可以強制讓變量進行序列化，可以在Unity的Editor上進行賦值。
在Class上使用[RequireComponent]屬性，就會在Class的GameObject上自動追加所需的Component。

以下是Unity官網文檔中找到的所有Attribute，下面將按照順序，逐個對這些Attribute進行說明和小的測試。
部分例子使用了Unity官方的示例。

UnityEngine

AddComponentMenu

可以在UnityEditor的Component的Menu中增加自定義的項目。菜單可以設置多級，使用斜線/分隔即可。在Hierarchy中選中GameObject的時候，點擊該菜單項，就可以在GameObject上追加該Component。
例如如下代碼可以完成下圖的效果。

1 2 3

[AddComponentMenu("TestMenu/TestComponet")] public class TestMenu : MonoBehaviour { }

AssemblyIsEditorAssembly

彙編級屬性，使用該屬性的Class會被認爲是EditorClass。具體用法不明。

ContextMenu

可以在Inspector的ContextMenu中增加選項。
例如，如下代碼的效果

1 2 3 4 5 6

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

ContextMenuItemAttribute

這個屬性是Unity4.5之後提供的新功能，可以在Inspector上面對變量追加一個右鍵菜單，並執行指定的函數。
例子：

1 2 3 4 5 6 7

public class Sample : MonoBehaviour {     [ContextMenuItem("Reset", "ResetName")]     public string name = "Default";     void ResetName() {         name = "Default";     } }

DisallowMultipleComponent

對一個MonoBehaviour的子類使用這個屬性，那麼在同一個GameObject上面，最多隻能添加一個該Class的實例。
嘗試添加多個的時候，會出現下面的提示。

ExecuteInEditMode

默認狀態下，MonoBehavior中的Start，Update，OnGUI等方法，需要在Play的狀態下才會被執行。
這個屬性讓Class在Editor模式（非Play模式）下也能執行。
但是與Play模式也有一些區別。
例如：
Update方法只在Scene編輯器中有物體產生變化時，纔會被調用。
OnGUI方法只在GameView接收到事件時，纔會被調用。

HeaderAttribute

這個屬性可以在Inspector中變量的上面增加Header。
例子：

1 2 3 4 5 6 7 8 9

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

HideInInspector

在變量上使用這個屬性，可以讓public的變量在Inspector上隱藏，也就是無法在Editor中進行編輯。

ImageEffectOpaque

在OnRenderImage上使用，可以讓渲染順序在非透明物體之後，透明物體之前。
例子

1 2 3

[ImageEffectOpaque] void OnRenderImage (RenderTexture source, RenderTexture destination){ }

ImageEffectTransformsToLDR

渲染從從HDR變爲LDR 具體使用方法不明。

MultilineAttribute

在string類型上使用，可以在Editor上輸入多行文字。

1 2 3 4

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

NotConvertedAttribute

在變量上使用，可以指定該變量在build的時候，不要轉換爲目標平臺的類型。

NotFlashValidatedAttribute

在變量上使用，在Flash平臺build的時候，對該變量不進行類型檢查。
Unity5.0中已經移除了這個屬性。

NotRenamedAttribute

禁止對變量和方法進行重命名。
Unity5.0中已經移除了這個屬性。

PropertyAttribute

RangeAttribute

在int或者float類型上使用，限制輸入值的範圍

1 2 3 4

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

RequireComponent

在Class上使用，添加對另一個Component的依賴。
當該Class被添加到一個GameObject上的時候，如果這個GameObject不含有依賴的Component，會自動添加該Component。
且該Componet不可被移除。

例子

1 2 3 4

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

如果嘗試移除被依賴的Component，會有如下提示

RPC

在方法上添加該屬性，可以網絡通信中對該方法進行RPC調用。

1 2 3

[RPC] void RemoteMethod(){ }

RuntimeInitializeOnLoadMethodAttribute

此屬性僅在Unity5上可用。
在遊戲啓動時，會自動調用添加了該屬性的方法。

1 2 3 4 5 6 7 8

class MyClass {     [RuntimeInitializeOnLoadMethod]     static void OnRuntimeMethodLoad ()     {         Debug.Log("Game loaded and is running");     } }

SelectionBaseAttribute

當一個GameObject含有使用了該屬性的Component的時候，在SceneView中選擇該GameObject，Hierarchy上面會自動選中該GameObject的Parent。

SerializeField

在變量上使用該屬性，可以強制該變量進行序列化。即可以在Editor上對變量的值進行編輯，即使變量是private的也可以。
在UI開發中經常可見到對private的組件進行強制序列化的用法。
例子

1 2 3 4 5 6 7

public class TestSerializeField : MonoBehaviour {     [SerializeField]     private string name;       [SerializeField]     private Button _button; }

SharedBetweenAnimatorsAttribute

用於StateMachineBehaviour上，不同的Animator將共享這一個StateMachineBehaviour的實例，可以減少內存佔用。

SpaceAttribute

使用該屬性可以在Inspector上增加一些空位。 例子：

1 2 3 4 5 6 7

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

TextAreaAttribute

該屬性可以把string在Inspector上的編輯區變成一個TextArea。
例子：

1 2 3 4

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

TooltipAttribute

這個屬性可以爲變量上生成一條tip，當鼠標指針移動到Inspector上時候顯示。

1 2 3 4

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

UnityAPICompatibilityVersionAttribute

用來聲明API的版本兼容性

UnityEngine.Serialization

FormerlySerializedAsAttribute

該屬性可以令變量以另外的名稱進行序列化，並且在變量自身修改名稱的時候，不會丟失之前的序列化的值。
例子:

1 2 3 4 5 6 7 8 9 10 11

using UnityEngine; using UnityEngine.Serialization; public class MyClass : MonoBehaviour {     [FormerlySerializedAs("myValue")]     private string m_MyValue;     public string myValue     {         get { return m_MyValue; }         set { m_MyValue = value; }     } }

UnityEngine.Editor

該package爲Editor開發專用

CallbackOrderAttribute

定義Callback的順序

CanEditMultipleObjects

Editor同時編輯多個Component的功能

CustomEditor

聲明一個Class爲自定義Editor的Class

CustomPreviewAttribute

將一個class標記爲指定類型的自定義預覽
Unity4.5以後提供的新功能
例子：

1 2 3 4 5 6 7 8 9 10 11 12 13

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

CustomPropertyDrawer

標記自定義PropertyDrawer時候使用。
當自己創建一個PropertyDrawer或者DecoratorDrawer的時候，使用該屬性來標記。 TODO: 如何創建屬於自己的Attribute

DrawGizmo

可以在Scene視圖中顯示自定義的Gizmo
下面的例子，是在Scene視圖中，當掛有MyScript的GameObject被選中，且距離相機距離超過10的時候，便顯示自定義的Gizmo。
Gizmo的圖片需要放入Assets/Gizmo目錄中。
例子：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

using UnityEngine; using UnityEditor;   public class MyScript : MonoBehaviour {      }   public class MyScriptGizmoDrawer {          [DrawGizmo (GizmoType.Selected | GizmoType.Active)]     static void DrawGizmoForMyScript (MyScript scr, GizmoType gizmoType) {         Vector3 position = scr.transform.position;                  if(Vector3.Distance(position, Camera.current.transform.position) > 10f)             Gizmos.DrawIcon (position, "300px-Gizmo.png");     }      }

InitializeOnLoadAttribute

在Class上使用，可以在Unity啓動的時候，運行Editor腳本。
需要該Class擁有靜態的構造函數。
做一個創建一個空的gameobject的例子。
例子：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

using UnityEditor; using UnityEngine;   [InitializeOnLoad] class MyClass {     static MyClass ()     {         EditorApplication.update += Update;         Debug.Log("Up and running");     }          static void Update ()     {         Debug.Log("Updating");     } }

InitializeOnLoadMethodAttribute

在Method上使用，是InitializeOnLoad的Method版本。
Method必須是static的。

MenuItem

在方法上使用，可以在Editor中創建一個菜單項，點擊後執行該方法，可以利用該屬性做很多擴展功能。 需要方法爲static。
例子：

1 2 3 4 5 6 7 8 9 10 11

using UnityEngine; using UnityEditor; using System.Collections;   public class TestMenuItem : MonoBehaviour {       [MenuItem ("MyMenu/Create GameObject")]     public static void CreateGameObject() {         new GameObject("lvmingbei's GameObject");     } }

PreferenceItem

使用該屬性可以定製Unity的Preference界面。
在這裏就使用官方的例子：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

using UnityEngine; using UnityEditor; using System.Collections;   public class OurPreferences {     // Have we loaded the prefs yet     private static bool prefsLoaded = false;          // The Preferences     public static bool boolPreference = false;          // Add preferences section named "My Preferences" to the Preferences Window     [PreferenceItem ("My Preferences")]     public static void PreferencesGUI () {         // Load the preferences         if (!prefsLoaded) {             boolPreference = EditorPrefs.GetBool ("BoolPreferenceKey", false);             prefsLoaded = true;         }                  // Preferences GUI         boolPreference = EditorGUILayout.Toggle ("Bool Preference", boolPreference);                  // Save the preferences         if (GUI.changed)             EditorPrefs.SetBool ("BoolPreferenceKey", boolPreference);     } }

UnityEditor.Callbacks

這個package中是三個Callback的屬性，都需要方法爲static的。

OnOpenAssetAttribute

在打開一個Asset後被調用。
例子：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

using UnityEngine; using UnityEditor; using UnityEditor.Callbacks;      public class MyAssetHandler {       [OnOpenAssetAttribute(1)]     public static bool step1(int instanceID, int line) {         string name = EditorUtility.InstanceIDToObject(instanceID).name;         Debug.Log("Open Asset step: 1 ("+name+")");         return false; // we did not handle the open     }       // step2 has an attribute with index 2, so will be called after step1     [OnOpenAssetAttribute(2)]     public static bool step2(int instanceID, int line) {         Debug.Log("Open Asset step: 2 ("+instanceID+")");         return false; // we did not handle the open     } }

PostProcessBuildAttribute

該屬性是在build完成後，被調用的callback。
同時具有多個的時候，可以指定先後順序。
例子：

1 2 3 4 5 6 7 8 9 10

using UnityEngine; using UnityEditor; using UnityEditor.Callbacks;      public class MyBuildPostprocessor {     [PostProcessBuildAttribute(1)]     public static void OnPostprocessBuild(BuildTarget target, string pathToBuiltProject) {         Debug.Log( pathToBuiltProject );         } }

PostProcessSceneAttribute

使用該屬性的函數，在scene被build之前，會被調用。
具體使用方法和PostProcessBuildAttribute類似。

好了本篇unity3d教程到此結束，下篇我 們再會！