Unity 编辑器预制体工具类PrefabUtility 常用函数和用法
简介
在Unity中，预制体（Prefab）是一种非常有用的工具，它允许我们创建可重复使用的对象和场景元素。Unity提供了许多内置的工具和函数来处理预制体，其中一个重要的类就是PrefabUtility。PrefabUtility类提供了一系列函数，用于创建、实例化和管理预制体。在本文中，我们将介绍PrefabUtility类的常用函数和用法。
创建和实例化
CreatePrefab
函数原型：public static GameObject CreatePrefab(string path, GameObject go);
CreatePrefab函数用于创建一个新的预制体。它接受两个参数：路径（path）和游戏对象（go）。路径参数指定了预制体的保存位置，而游戏对象参数则是要创建预制体的对象。
以下是CreatePrefab函数的示例使用代码：
using UnityEditor;
using UnityEngine;
public class PrefabCreator : MonoBehaviour
{
[MenuItem("Tools/Create Prefab")]
public static void CreatePrefab()
{
GameObject selectedObject = Selection.activeGameObject;
if (selectedObject != null)
{
string path = "Assets/Prefabs/" + selectedObject.name + ".prefab";
GameObject prefab = PrefabUtility.CreatePrefab(path, selectedObject);
Debug.Log("Prefab created at " + path);
}
}
}
上述代码创建了一个名为PrefabCreator的脚本，并在Unity编辑器的菜单栏中添加了一个名为"Tools/Create Prefab"的选项。当用户选择一个游戏对象并点击该选项时，脚本将使用PrefabUtility.CreatePrefab函数创建一个预制体，并将其保存在Assets/Prefabs目录下。
CreateEmptyPrefab
函数原型：public static GameObject CreateEmptyPrefab(string path);
CreateEmptyPrefab函数用于创建一个空的预制体。它接受一个路径参数，指定了预制体的保存位置。
以下是CreateEmptyPrefab函数的示例使用代码：
using UnityEditor;
using UnityEngine;
public class EmptyPrefabCreator : MonoBehaviour
{
[MenuItem("Tools/Create Empty Prefab")]
public static void CreateEmptyPrefab()
{
string path = "Assets/Prefabs/EmptyPrefab.prefab";
GameObject prefab = PrefabUtility.CreateEmptyPrefab(path);
Debug.Log("Empty prefab created at " + path);
}
}
上述代码创建了一个名为EmptyPrefabCreator的脚本，并在Unity编辑器的菜单栏中添加了一个名为"Tools/Create Empty Prefab"的选项。当用户点击该选项时，脚本将使用PrefabUtility.CreateEmptyPrefab函数创建一个空的预制体，并将其保存在Assets/Prefabs目录下。
InstantiatePrefab
函数原型：public static GameObject InstantiatePrefab(GameObject prefab, Transform parent);
InstantiatePrefab函数用于实例化一个预制体。它接受两个参数：预制体（prefab）和父级变换（parent）。预制体参数指定了要实例化的预制体，而父级变换参数指定了实例化后的对象的父级。
以下是InstantiatePrefab函数的示例使用代码：
using UnityEditor;
using UnityEngine;
public class PrefabInstantiator : MonoBehaviour
{
[MenuItem("Tools/Instantiate Prefab")]
public static void InstantiatePrefab()
{
GameObject prefab = AssetDatabase.LoadAssetAtPath<GameObject>("Assets/Prefabs/MyPrefab.prefab");
Transform parent = GameObject.Find("Parent").transform;
GameObject instance = PrefabUtility.InstantiatePrefab(prefab, parent) as GameObject;
Debug.Log("Prefab instantiated");
}
}
上述代码创建了一个名为PrefabInstantiator的脚本，并在Unity编辑器的菜单栏中添加了一个名为"Tools/Instantiate Prefab"的选项。当用户点击该选项时，脚本将使用PrefabUtility.InstantiatePrefab函数实例化一个预制体，并将其作为子对象添加到名为"Parent"的游戏对象下。
InstantiatePrefabInScene
函数原型：public static GameObject InstantiatePrefabInScene(GameObject prefab, Vector3 position, Quaternion rotation);
InstantiatePrefabInScene函数用于在场景中实例化一个预制体。它接受三个参数：预制体（prefab）、位置（position）和旋转（rotation）。预制体参数指定了要实例化的预制体，位置参数指定了实例化后的对象的位置，旋转参数指定了实例化后的对象的旋转。
以下是InstantiatePrefabInScene函数的示例使用代码：
using UnityEditor;
using UnityEngine;
public class ScenePrefabInstantiator : MonoBehaviour
{
[MenuItem("Tools/Instantiate Prefab in Scene")]
public static void InstantiatePrefabInScene()
{
GameObject prefab = AssetDatabase.LoadAssetAtPath<GameObject>("Assets/Prefabs/MyPrefab.prefab");
Vector3 position = new Vector3(0, 0, 0);
Quaternion rotation = Quaternion.identity;
GameObject instance = PrefabUtility.InstantiatePrefabInScene(prefab, position, rotation) as GameObject;
Debug.Log("Prefab instantiated in scene");
}
}
上述代码创建了一个名为ScenePrefabInstantiator的脚本，并在Unity编辑器的菜单栏中添加了一个名为"Tools/Instantiate Prefab in Scene"的选项。当用户点击该选项时，脚本将使用PrefabUtility.InstantiatePrefabInScene函数在场景中实例化一个预制体，并将其放置在位置(0, 0, 0)，并保持旋转为默认值。
操作和修改函数
ReplacePrefab
函数签名：public static GameObject ReplacePrefab(GameObject go, GameObject prefab, ReplacePrefabOptions options = ReplacePrefabOptions.Default);
该函数用于替换预制体的实例。它接受两个参数：go表示要替换的游戏对象实例，prefab表示要替换成的预制体。可选参数options用于指定替换预制体的选项。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
GameObject prefab = Resources.Load<GameObject>("Prefabs/MyPrefab");
PrefabUtility.ReplacePrefab(go, prefab, ReplacePrefabOptions.ConnectToPrefab);
ConnectGameObjectToPrefab
函数签名：public static GameObject ConnectGameObjectToPrefab(GameObject go, GameObject prefab);
该函数用于将游戏对象连接到预制体。它接受两个参数：go表示要连接的游戏对象，prefab表示要连接到的预制体。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
GameObject prefab = Resources.Load<GameObject>("Prefabs/MyPrefab");
PrefabUtility.ConnectGameObjectToPrefab(go, prefab);
DisconnectPrefabInstance
函数签名：public static void DisconnectPrefabInstance(GameObject gameObject);
该函数用于断开游戏对象与预制体的连接。它接受一个参数：gameObject表示要断开连接的游戏对象。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
PrefabUtility.DisconnectPrefabInstance(go);
ApplyPrefabInstance
函数签名：public static void ApplyPrefabInstance(GameObject instanceRoot, InteractionMode interactionMode = InteractionMode.UserAction);
该函数用于将游戏对象的修改应用到预制体实例。它接受两个参数：instanceRoot表示要应用修改的游戏对象实例的根节点，interactionMode用于指定应用修改的交互模式。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
PrefabUtility.ApplyPrefabInstance(go, InteractionMode.AutomatedAction);
RevertPrefabInstance
函数签名：public static void RevertPrefabInstance(GameObject gameObject);
该函数用于还原游戏对象到预制体实例的状态。它接受一个参数：gameObject表示要还原的游戏对象。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
PrefabUtility.RevertPrefabInstance(go);
查询和检查函数
GetPrefabType
函数签名：public static PrefabType GetPrefabType(Object targetObject);
该函数用于获取预制体的类型。它接受一个参数targetObject，表示要查询的对象，可以是游戏对象或组件。
返回值类型为PrefabType，表示预制体的类型。可能的返回值包括：
-
None：表示对象不是预制体的一部分。 -
Prefab：表示对象是一个完整的预制体。 -
PrefabInstance：表示对象是一个预制体的实例。 -
DisconnectedPrefabInstance：表示对象是一个断开连接的预制体实例。 -
PrefabAsset：表示对象是一个预制体资源。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
PrefabType prefabType = PrefabUtility.GetPrefabType(go);
Debug.Log("Prefab Type: " + prefabType);
GetPrefabParent
函数签名：public static GameObject GetPrefabParent(GameObject gameObject);
该函数用于获取预制体的父级。它接受一个参数gameObject，表示要查询的游戏对象。
返回值类型为GameObject，表示预制体的父级对象。如果对象不是预制体的一部分，则返回null。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
GameObject prefabParent = PrefabUtility.GetPrefabParent(go);
Debug.Log("Prefab Parent: " + prefabParent);
GetPrefabObject
函数签名：public static GameObject GetPrefabObject(GameObject gameObject);
该函数用于获取预制体的对象。它接受一个参数gameObject，表示要查询的游戏对象。
返回值类型为GameObject，表示预制体的对象。如果对象不是预制体的一部分，则返回null。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
GameObject prefabObject = PrefabUtility.GetPrefabObject(go);
Debug.Log("Prefab Object: " + prefabObject);
GetPrefabInstanceHandle
函数签名：public static PrefabInstanceHandle GetPrefabInstanceHandle(GameObject gameObject);
该函数用于获取预制体实例的句柄。它接受一个参数gameObject，表示要查询的游戏对象。
返回值类型为PrefabInstanceHandle，表示预制体实例的句柄。如果对象不是预制体的实例，则返回一个无效的句柄。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
PrefabInstanceHandle instanceHandle = PrefabUtility.GetPrefabInstanceHandle(go);
Debug.Log("Prefab Instance Handle: " + instanceHandle);
GetCorrespondingObjectFromSource
函数签名：public static Object GetCorrespondingObjectFromSource(Object sourceObject);
该函数用于从预制体实例获取对应的源对象。它接受一个参数sourceObject，表示预制体实例中的对象。
返回值类型为Object，表示源对象。如果对象不是预制体实例的一部分，则返回null。
使用示例：
GameObject go = GameObject.Find("MyGameObject");
Object sourceObject = PrefabUtility.GetCorrespondingObjectFromSource(go);
Debug.Log("Source Object: " + sourceObject);
其他类型
1. 获取预制体实例根节点的路径
函数名：GetPrefabAssetPathOfNearestInstanceRoot
public static string GetPrefabAssetPathOfNearestInstanceRoot(GameObject instanceRoot);
该函数用于获取最近的预制体实例根节点的路径。它接受一个GameObject参数，表示预制体实例的根节点，然后返回一个字符串，表示该预制体实例根节点所对应的预制体的路径。
返回值：
- 如果传入的GameObject参数是一个预制体实例的根节点，则返回该预制体的路径。
- 如果传入的GameObject参数不是预制体实例的根节点，则返回空字符串。
示例代码：
GameObject instance = PrefabUtility.GetPrefabInstanceHandle(gameObject);
string prefabPath = PrefabUtility.GetPrefabAssetPathOfNearestInstanceRoot(instance);
Debug.Log("Prefab Path: " + prefabPath);
2. 获取预制体实例的数量
函数名：GetPrefabInstanceCount
public static int GetPrefabInstanceCount(Object targetPrefab);
该函数用于获取指定预制体的实例数量。它接受一个Object参数，表示目标预制体，可以是预制体的引用或实例。
返回值：
- 返回一个整数，表示指定预制体的实例数量。
示例代码：
GameObject prefab = PrefabUtility.GetCorrespondingObjectFromSource(gameObject);
int instanceCount = PrefabUtility.GetPrefabInstanceCount(prefab);
Debug.Log("Instance Count: " + instanceCount);
3. 获取预制体实例的列表
函数名：GetPrefabInstanceList
public static List<GameObject> GetPrefabInstanceList(Object targetPrefab);
该函数用于获取指定预制体的所有实例列表。它接受一个Object参数，表示目标预制体，可以是预制体的引用或实例。
返回值：
- 返回一个List<GameObject>，包含指定预制体的所有实例。
示例代码：
GameObject prefab = PrefabUtility.GetCorrespondingObjectFromSource(gameObject);
List<GameObject> instanceList = PrefabUtility.GetPrefabInstanceList(prefab);
foreach (GameObject instance in instanceList)
{
Debug.Log("Prefab Instance: " + instance.name);
}
4. 获取预制体实例的状态
函数名：GetPrefabInstanceStatus
public static PrefabInstanceStatus GetPrefabInstanceStatus(Object targetObject);
该函数用于获取指定对象的预制体实例状态。它接受一个Object参数，表示目标对象，可以是预制体的引用或实例。
返回值：
- 返回一个PrefabInstanceStatus枚举值，表示指定对象的预制体实例状态。可能的枚举值包括：
- Connected：表示对象是一个预制体实例，并且与预制体保持连接。
- Disconnected：表示对象是一个预制体实例，但与预制体断开连接。
- NotAPrefab：表示对象不是一个预制体实例。
示例代码：
GameObject instance = PrefabUtility.GetPrefabInstanceHandle(gameObject);
PrefabInstanceStatus instanceStatus = PrefabUtility.GetPrefabInstanceStatus(instance);
Debug.Log("Instance Status: " + instanceStatus);
结论
在本文中，我们介绍了Unity编辑器中PrefabUtility类的常用函数和用法。我们学习了如何获取预制体实例的路径、数量、列表和状态，并解释了每个函数返回值的具体含义。通过使用PrefabUtility类，我们可以更好地管理和操作预制体，提高开发效率。
