Unity3d 在代碼中獲取此腳本所在的路徑

需求

Unity3d編輯器腳本時而不時會有數據持久化需求,換句話說就是寫入數據、保存配置的需求,怎么保存數據先不談,但我們都知道,想要自己寫的工具不污染整個工程的結構,往往我們需要將配置文件(生成的新文件)跟工具腳本整一起,或上一個目錄,或同級目錄,或同級下的子目錄。
于是,“在指定腳本的周邊目錄下動態創建文件夾”的需求就這樣應運而生啦!

代碼

簡單的描述完這個需求的使用場景,下面我們直接上代碼:

using System.IO;
using System.Linq;
#if UNITY_EDITOR
using ADB = UnityEditor.AssetDatabase;
#endif

public static class FolderMaker
{

    /// <summary>
    /// 編輯器下使用,給定一個類的對象,在這個類的同級目錄下創建文件夾并返回路徑
    /// </summary>
    /// <typeparam name="T">類</typeparam>
    /// <param name="script">對象</param>
    /// <param name="subPath">指定要創建的文件夾的名稱</param>
    /// <returns>文件夾的相對路徑,相對于Assets文件夾</returns>
    public static string Creat<T>(T script, string subPath) where T : UnityEngine.Object //class  
    {
        string newPath = "";
#if UNITY_EDITOR
        string path = ADB.FindAssets("t:Script")
            .Where(v => Path.GetFileNameWithoutExtension(ADB.GUIDToAssetPath(v)) == script.GetType().Name)
            .Select(id => ADB.GUIDToAssetPath(id))
            .FirstOrDefault()
            .ToString();
        //newPath = path.Remove(path.LastIndexOf("/") + 1, Path.GetFileName(path).Length) + subPath; 
        newPath =Path.Combine( Path.GetDirectoryName(path) ,subPath);

        if (!ADB.IsValidFolder(newPath))
        {
            newPath = ADB.GUIDToAssetPath(ADB.CreateFolder(path, subPath));
        }
#endif
        return newPath;
    }
}
    /// <summary>
    /// 編輯器下使用,給定一個類型,在這個類的周邊目錄下創建文件夾并返回路徑
    /// </summary>
    /// <param name="script">對象</param>
    /// <param name="subPath">指定要創建的文件夾的名稱</param>
    /// <returns>文件夾的相對路徑,相對于Assets文件夾</returns>
    public static string Creat(Type script, string subPath)
    {
#if UNITY_EDITOR
        string path = ADB.FindAssets("t:Script")
            .Where(v => Path.GetFileNameWithoutExtension(ADB.GUIDToAssetPath(v)) == script.Name)
            .Select(id => ADB.GUIDToAssetPath(id))
            .FirstOrDefault()
            .ToString();
        path = Path.GetDirectoryName(path);  //去除文件名
        path = Path.GetFullPath(path + "/" + subPath); //整合到完整路徑,使用"/../" 回退到上一目錄
        if (!Directory.Exists(path))
        {
            Directory.CreateDirectory(path);
        }
#endif
        return path;
    }

Tips:

  1. using的使用:AssetDatabase 這個類用的簡直不要太頻繁,使用using ADB = UnityEditor.AssetDatabase;給他取個別名“ADB”。
  2. 預編譯指令的使用:預編譯指令是必不可少的,如果這個腳本處于Editor文件夾下,繼承MonoBehavior的類將無法訪問。挪出來就挺不錯,但此時如不使用預編譯指令,打包便會報錯~
  3. 泛型的使用:泛型的使用使得邏輯復用,同時也能類型安全,where T:UnityEngine.Object 限制了使用環境是Unity,如果限制僅僅為 class ,嗯,隨便一個字符串就能打發第一個參數,當然運行也就得不到我們想要的結果,報錯呢,也肯定是要報的了。
  4. 實現思路,就是輪番使用UnityEditor下的API,查找到這個腳本,拿到腳本所在的目錄拼接并創建新的目錄。

2019年1月11日 補充:

  • 可以看到筆者在上面提供的代碼塊中又重載了這個方法,通過這個重載,現在不提供實例也能獲取路徑啦。
  • 另外,IO操作大幅回歸System.IO的API,主要是為了解決2個問題:
    1. 得到上一個文件夾路徑 ,使用File.GetFullPath(path),只要在傳的參數中拼接 “../” 就能得到上一級目錄,拼接多個就能回退多步。
    2. 遞歸創建文件夾,只需給定一個路徑就好。

使用方法:↓

//返回腳本所在的目錄的上兩級,然后創建2個文件夾
  var path =FolderMaker.Creat(typeof(TagEnumGenarator),@"/../../aa/Bb") + "/EnumTag.cs";

2019年1月18日 補充

    /// <summary>
    /// 編輯器下使用,給定一個類型,在這個類的周邊目錄下創建文件夾并返回路徑
    /// </summary>
    /// <param name="script">對象</param>
    /// <param name="subPath">指定要創建的文件夾的名稱</param>
    /// <returns>文件夾的相對路徑,相對于Assets文件夾</returns>
    public static string Creat(MonoBehaviour script, string subPath)
    {
#if UNITY_EDITOR
        MonoScript m_Script = MonoScript.FromMonoBehaviour(script); //更新 使用UnityEditor API 
        string path = AssetDatabase.GetAssetPath(m_Script);
        path = Path.GetDirectoryName(path);  //去除文件名
        path = Path.GetFullPath(path + "/" + subPath); //整合到完整路徑,使用"/../" 回退到上一目錄
        if (!Directory.Exists(path))
        {
            Directory.CreateDirectory(path);
        }
#endif
        return path;
    }

很多時候,Unity 要的是相對于Assets 文件夾的相對路徑,加一句就行了,順便改下方法名,感覺這個方法名與功能才是真的對口

    /// <summary>
    /// 編輯器下使用,給定一個類型,在這個類的周邊目錄下創建文件夾并返回相對路徑
    /// </summary>
    /// <param name="script">ScriptableObject 對象</param>
    /// <param name="subPath">指定要創建的文件夾的名稱</param>
    /// <returns>文件夾的相對路徑,相對于Assets文件夾</returns>
    public static string AllocateLocalPath(ScriptableObject script, string subPath)
    {
#if UNITY_EDITOR
        MonoScript m_Script = MonoScript.FromScriptableObject(script); //更新 使用UnityEditor API 
        string path = AssetDatabase.GetAssetPath(m_Script);
        path = Path.GetDirectoryName(path);  //去除文件名
        path = Path.GetFullPath(path + "/" + subPath); //整合到完整路徑,使用"/../" 回退到上一目錄
        if (!Directory.Exists(path))
        {
            Directory.CreateDirectory(path);
        }
        path = path.Substring(path.IndexOf("Assets"));
#endif
        return path;
    }

Tips:

  • 在Unity編輯器,腳本文件也是一個資源,并且是一個文本資源,由MonoScript表示,通過 UnityEditor.MonoScript.FromMonoBehaviour(MonoBehaviour script)拿到。
  • Unity編輯器模式下,有一套資源管理體系,UnityEditor.AssetDatabase.GetAssetPath(Object assetObject)就可以拿到腳本資源的路徑。
  • 從對上述提及的方法簽名的描述可知,傳入 MonoScript 實例就能得到腳本路徑啦。

使用

使用沒什么要說的,調用一下這個方法就好了,譬如:

using UnityEngine;
public class Car : MonoBehaviour
{
    private void Update()
    {
        if (Input.GetMouseButtonDown(0))
        {
            Debug.Log(FolderMaker.Creat(this,"HAHA"+Random.Range(1,150)));
        }
    }
}

但是需要了解的是,盡管這個返回的路徑是相對值,但很夠用呀,如果想要完整路徑的,加上這句就好了:


2024年7月3日 更新

通過以下方式也能獲得腳本路徑,但是需要區分這個路徑是系統路徑還是編輯器規則下的路徑

              var stack = new StackTrace(true);
              var path = stack.GetFrame(0).GetFileName();

比如,Packages 中的路徑就很奇怪,物理路徑跟編輯器內路徑是不一致的,下面截圖表示:

系統路徑 Unity路徑

在系統的文件系統中 路徑是:E:\Unity\Test\TestBuildLinux\Library\PackageCache\com.unity.editorcoroutines@1.0.0/README.md
然而在 Unity 中,他的路徑是:Packages/com.unity.editorcoroutines/README.md

動畫

  1. 在上面的動畫中,每一次點擊鼠標左鍵便會創建一個文件夾,文件夾名稱以“HAHA”開頭加上一串隨機數。
  2. 另外,筆者在Unity播放狀態拖拽并移動了Car這個腳本的位置,但事實上不建議大家這么做。
  3. 其實,這個解決方案只是為了實現編輯器腳本配置文件自動跟隨而作,動圖演示的貌似用處不大。

總結

這是一個簡單的筆記,希望遇到有需要的人~

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,837評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,196評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,688評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,654評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,456評論 6 406
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,955評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,044評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,195評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,725評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,608評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,802評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,318評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,048評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,422評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,673評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,424評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,762評論 2 372

推薦閱讀更多精彩內容