unity學習教程之定制腳本模板示例代碼

2019-10-29 19:32:17

字體：大中小

來源：轉載

供稿：網友

1、unity的腳本模板

新版本unity中的C#腳本有三類，第一類是我們平時開發用的C# Script；第二類是Testing，用來做單元測試；第三類是Playables，用作TimeLine中管理時間線上每一幀的動畫、聲音等。我們點擊創建腳本時，會自動生成unity內置的一套模板：

using System.Collections;using System.Collections.Generic;using UnityEngine;public class NewBehaviourScript : MonoBehaviour { // Use this for initialization void Start () {   }  // Update is called once per frame void Update () {   }}

如果我們開發時使用的框架有明顯的一套基礎模板，那為項目框架定制一套模板會很有意義，這樣可以為我們省去編寫重復代碼的時間。這里介紹兩種方法。

2、修改默認腳本模板

打開unity安裝目錄，比如D:/unity2018/Editor/Data/Resources/ScriptTemplates，unity內置的模板腳本都在這里，那么可以直接修改這里的cs文件，比如我們將81-C# Script-NewBehaviourScript.cs.txt文件修改為如下，那下次創建C# Script時模板就會變成這樣：

//////////////////////////////////////////////////////////////////////       _ooOoo_        ////       o8888888o        ////       88" . "88        ////       (| ^_^ |)        ////       O/ = /O        ////      ____/`---'/____       ////     .' //|  |// `.       ////     / //||| : |||// /      ////     / _||||| -:- |||||- /      ////     | | /// - /// | |      ////     | /_| ''/---/'' | |      ////     / .-/__ `-` ___/-. /      ////    ___`. .' /--.--/ `. . ___      ////    ."" '< `.___/_<|>_/___.' >'"".     ////   | | : `- /`.;`/ _ /`;.`/ - ` : | |     ////   / / `-. /_ __/ /__ _/ .-` / /     ////  ========`-.____`-.___/_____/___.-`____.-'========   ////       `=---='        ////  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^  ////   佛祖保佑  永不宕機  永無BUG     //////////////////////////////////////////////////////////////////////using System.Collections;using System.Collections.Generic;using UnityEngine;public class #SCRIPTNAME# : MonoBehaviour { // Use this for initialization void Start () {  #NOTRIM# }  // Update is called once per frame void Update () {  #NOTRIM# }}

3、拓展腳本模板

上面講的第一種方法直接修改了unity的默認配置，這并不適應于所有項目，這里第二種方法會更有效，可以針對不同的項目和框架創建合適的腳本模板。

首先，先創建一個文本文件MyTemplateScript.cs.txt作為腳本模板，并將其放入unity project的Editor文件夾下，模板代碼為：

using System.Collections;using System.Collections.Generic;using UnityEngine;public class MyNewBehaviourScript : MonoBase { //添加事件監聽 protected override void AddMsgListener() { }  //處理消息 protected override void HandleMsg(MsgBase msg) {  switch (msg.id)  {   default:    break;  } }}

我們使用時，需要在Project視圖中右擊->Create->C# FrameScript 創建腳本模板，因此首先要創建路徑為Assets/Create/C# FrameScript的MenuItem，點擊創建腳本后，需要修改腳本名字，因此需要在拓展編輯器腳本中繼承EndNameEditAction來監聽回調，最終實現輸入腳本名字后自動創建相應的腳本模板。

unity,腳本,模板,代碼

代碼如下，將這個腳本放入Editor文件夾中：

using UnityEditor;using UnityEngine;using System;using System.IO;using UnityEditor.ProjectWindowCallback;using System.Text;using System.Text.RegularExpressions;public class CreateTemplateScript {  //腳本模板路徑  private const string TemplateScriptPath = "Assets/Editor/MyTemplateScript.cs.txt";  //菜單項  [MenuItem("Assets/Create/C# FrameScript", false, 1)]  static void CreateScript()  {    string path = "Assets";    foreach (UnityEngine.Object item in Selection.GetFiltered(typeof(UnityEngine.Object),SelectionMode.Assets))    {      path = AssetDatabase.GetAssetPath(item);      if (!string.IsNullOrEmpty(path) && File.Exists(path))      {        path = Path.GetDirectoryName(path);        break;      }    }    ProjectWindowUtil.StartNameEditingIfProjectWindowExists(0, ScriptableObject.CreateInstance<CreateScriptAsset>(),    path + "/MyNewBehaviourScript.cs",    null, TemplateScriptPath);  }  }class CreateScriptAsset : EndNameEditAction{  public override void Action(int instanceId, string newScriptPath, string templatePath)  {    UnityEngine.Object obj= CreateTemplateScriptAsset(newScriptPath, templatePath);    ProjectWindowUtil.ShowCreatedAsset(obj);  }  public static UnityEngine.Object CreateTemplateScriptAsset(string newScriptPath, string templatePath)  {    string fullPath = Path.GetFullPath(newScriptPath);    StreamReader streamReader = new StreamReader(templatePath);    string text = streamReader.ReadToEnd();    streamReader.Close();    string fileNameWithoutExtension = Path.GetFileNameWithoutExtension(newScriptPath);    //替換模板的文件名    text = Regex.Replace(text, "MyTemplateScript", fileNameWithoutExtension);    bool encoderShouldEmitUTF8Identifier = true;    bool throwOnInvalidBytes = false;    UTF8Encoding encoding = new UTF8Encoding(encoderShouldEmitUTF8Identifier, throwOnInvalidBytes);    bool append = false;    StreamWriter streamWriter = new StreamWriter(fullPath, append, encoding);    streamWriter.Write(text);    streamWriter.Close();    AssetDatabase.ImportAsset(newScriptPath);    return AssetDatabase.LoadAssetAtPath(newScriptPath, typeof(UnityEngine.Object));  }}

然后，在project中，點擊創建C# FrameScript，輸入腳本名字，對應的腳本就已經創建好了

unity,腳本,模板,代碼