Unity のスクリプトテンプレートをカスタマイズしたい – Unity

この記事は、以下に該当するお客様向けのご案内です。

新しいスクリプトを作成すると、Unity Editor がその内容を自動生成する。C# スクリプトの場合は、ファイル名をクラス名として使用している。

原因:

スクリプトテンプレートは、以下のパスに格納されています。

%EDITOR_PATH%Data\Resources%ScriptTemplates

解決策:

新しいスクリプトを作成する際には、Unity Editor がその内容を自動生成します。C#スクリプトの場合は、ファイル名をクラス名として使用します。

以下は自動生成された内容の例です。

using UnityEngine;
using System.Collections;




public class MyCustomScript : MonoBehaviour {




	// Use this for initializationvoid Start () {
	
	}
	
	// Update is called once per framevoid Update () {

自動生成されるスクリプトの内容を変更するには、以下のパスに保存されているスクリプトテンプレートを変更することで可能です。

Windows: C:\Program Files\Unity\Editor\Data\Resources\ScriptTemplates
Mac: /Applications/Unity/Editor/Data/Resources/ScriptTemplates
Mac (5.2.1f1 以降): /Applications/Unity/Unity.app/Contents/Resources/ScriptTemplates

このディレクトリには、いくつかのテンプレートファイルがあります。

81-C# Script-NewBehaviourScript.cs.txt
82-Javascript-NewBehaviourScript.js.txt
83-Shader__Standard Surface Shader-NewSurfaceShader.shader.txt
84-Shader__Unlit Shader-NewUnlitShader.shader.txt
...

別の C# スクリプトテンプレートが必要な場合は、81-C# Script-NewBehaviourScript.cs.txt ファイルを編集してください。

デフォルトではファイルの内容は以下のようになっています。

using UnityEngine;
using System.Collections;
 
public class #SCRIPTNAME# : MonoBehaviour {
 
	// Use this for initializationvoid Start () {
	
	}
	
	// Update is called once per framevoid Update () {
	
	}
}

テンプレートは自由に変更できますが、#SCRIPTNAME# は必ずそのままにしておいてください。これがなければテンプレートのクラス名が自動変更されず、誤ったクラス名でスクリプトが生成される可能性があります。

編集後の C# テンプレート例を示します。

/* * Modified template by Unity Support. */using UnityEngine;
 
public class #SCRIPTNAME# : MonoBehaviour
{
    #region Public Fields#endregion#region Unity Methodsvoid Start()
    {
    }
 
    void Update()
    {
    }
    #endregion#region Private Methods#endregion
}

テンプレートファイルを変更した後は、Unity Editor を再起動して変更を適用してください。

オリジナルのテンプレートファイルと、変更後のテンプレートファイルは必ずバックアップを取っておいてください。テンプレートが正しく認識されない場合など、元のファイルが必要になる可能性があります。もしテンプレートが正しく認識されない場合は、再度作り直してみてください。

また、編集後のテンプレートのコピーを Unity のディレクトリの外に保存しておくことを強くお勧めします。なぜなら、Unity のバージョンをアップグレードするとテンプレートファイルは上書きされてしまうからです。その際は、編集したテンプレートに再度置き換える必要があります。

注意: Assets フォルダ上に ScriptTemplates フォルダを作成し、上記の手順を踏むことで、特定のプロジェクト内でスクリプトテンプレートを割り当てることができます。

詳細については以下の記事をご確認ください。

Unity Project で Unity のスクリプトテンプレートをカスタマイズしたい

参考情報:

原因:

解決策:

参考情報:

関連記事