Unity Editor从模板创建脚本

我们使用 Visual Studio + Unity 开发游戏的时候 Unity为我们提供了MonoBehaviour 脚本的模板,在 Project 下的 Assets 面板下点击右键,在弹出的菜单中点 Create -> C# Script就可以创建MonoBehaviour 脚本。

但是创建出来的脚本文件不是 utf-8 格式的,导致我们写的注释经常乱码,而且代码也没有格式化,需要我们手动格式化,非常麻烦。所以我们可以编写 Editor 脚本来实现从我们自定义的模板中创建代码。除了有以上两点好处,还可以添加命名空间,或者你想自定义的任何内容,非常方便,可以大大减少一些重复而枯燥的工作。

首先创建模板脚本放在指定的目录下然后创脚本 CreateClass.cs 放在Editor 目录下。

CreateClass.cs 脚本内容如下:


//---------------------------------------------------------------------
// XRLGame
// Copyright © 2019-2022 XRLGame Co., Ltd. All rights reserved.
// Author: JerryYang
// Time: 2022-10-21 14:28:41
// Feedback: yang2686022430@163.com
//---------------------------------------------------------------------

using UnityEngine;
using UnityEditor;
using UnityEditor.ProjectWindowCallback;
using System.IO;
using System.Text;

namespace XRL
{
  /// <summary>
  /// 从模板创建文件,有如下好处:
  /// 1. 编码格式统一为UTF-8带签名
  /// 2. 代码统一格式化
  /// 3. 添加命名空间
  /// </summary>
  public class CreateClass : MonoBehaviour
  {
    [MenuItem("Assets/CreateClass/MonoBehaviour")]
    public static void CreateMonoBehaviour()
    {
      string templatePath = "Assets/XRLGame/Editor/Templates/csharp/MonoBehaviour.txt";
      Create(templatePath);
    }

    [MenuItem("Assets/CreateClass/XRLMonoBehaviour")]
    public static void CreateXRLMonoBehaviour()
    {
      string templatePath = "Assets/XRLGame/Editor/Templates/csharp/XRLMonoBehaviour.txt";
      Create(templatePath);
    }

    private static void Create(string path) 
    {
      if (IsSelectedFolder())
      {
        string folderPath = AssetDatabase.GUIDToAssetPath(Selection.assetGUIDs[0]);

        // 创建代码文件的过程中,在重命名时调用该方法
        Texture2D icon = EditorGUIUtility.IconContent("d_cs Script Icon").image as Texture2D;
        ProjectWindowUtil.StartNameEditingIfProjectWindowExists(0,
          ScriptableObject.CreateInstance<CreateScriptAsset>(),
          folderPath + "/CreateScript.cs",
          icon,
          path);
      }
    }

    private static bool IsSelectedFolder()
    {
      return Path.GetExtension(AssetDatabase.GUIDToAssetPath(Selection.assetGUIDs[0])) == string.Empty;
    }
  }

  public class CreateScriptAsset : EndNameEditAction
  {
    // 重命名新创建的Script时,调用它
    public override void Action(int instanceId, string pathName, string resourceFile)
    {
      // 基于模板文件生成具体文件时,需替换文件中的部分内容:如类名替换为文件名
      UnityEngine.Object obj = CreateTemplateScriptAsset(pathName, resourceFile);
      ProjectWindowUtil.ShowCreatedAsset(obj);
    }

    private static UnityEngine.Object CreateTemplateScriptAsset(string newScriptPath, string templatePath)
    {
      // 读入模板内容
      StreamReader sr = new StreamReader(templatePath);
      string content = sr.ReadToEnd();
      sr.Close();

      // 修改内容中的部分内容
      content = content.Replace("#ScriptName#", Path.GetFileNameWithoutExtension(newScriptPath));
      content = content.Replace("#Author#", "JerryYang");
      content = content.Replace("#CreateTime#", System.DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
      content = content.Replace("#Copyright#", "Copyright © 2019-2022 XRLGame Co., Ltd. All rights reserved.");
      content = content.Replace("#Feedback#", "yang2686022430@163.com.");

      // 将修改后的内容写入新创建的文件
      StreamWriter sw = new StreamWriter(Path.GetFullPath(newScriptPath), false, new UTF8Encoding(true, false));
      sw.Write(content);
      sw.Close();

      // 导入资源
      AssetDatabase.ImportAsset(newScriptPath);
      return AssetDatabase.LoadAssetAtPath(newScriptPath, typeof(UnityEngine.Object));
    }
  }
}

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

推荐阅读更多精彩内容