Comment créer un template de script pour Unity personnalisé ? : Unity

Dans l'éditeur de Unity, lorsque l'on crée un nouveau script, l’éditeur Unity génère une base de script par défaut. 

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class MyScript : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        
    }

    // Update is called once per frame
    void Update()
    {
        
    }
}

Mais cette base n'est pas forcément celle que vous aimeriez avoir, non ? Savez vous qu'il est possible de changer ce script par défaut ?

En effet pouvoir enlever le sempiternel commentaire, ce ne serait pas du luxe, n'est-ce pas ? D'autant que depuis le temps, vous savez très bien ce que font les méthodes Start et Update ....

// Update is called once per frame

En effet devoir enlever systématiquement ces commentaires, ou encore ajouter d'autres méthodes qui vous sont utiles .. ça prend du temps et ce n'est pas efficace. 

Aussi dans ce tutoriel nous allons voir comment customiser le template par défaut lors de la génération d'un nouveau script C#.

Repérez les templates de script dans votre éditeur Unity

En fouillant un peu les dossiers de l'éditeur de la version de Unity dont vous voulez changer le template de script, on peut trouver des fichiers .txt qui comportent le template qui sera utilisé pour générer le script C#.

Aussi rendez vous dans :

• Windows : C:\Program Files\Hub\Editor\<UnityVersionQueVousVoulezChanger>\Data\Resources\ScriptTemplates
• MacOS : /Applications/Hub/Editor/<UnityVersionQueVousVoulezChanger>/Unity.app/Contents/Resources/ScriptTemplates

Il est à noter que pour Mac, il y a une petite subtilité, il faut bien ouvrir le contenu de l'application

Clic Droit => Afficher contenu du paquet

Ainsi vous devriez pouvoir rejoindre le bon dossier indiqué plus haut ! Pensez bien à changer <UnityVersionQueVousVoulezChanger>, par le nom de l'éditeur sur lequel vous voulez appliquer votre travail. (Dans l'exemple de la photo ci-dessus => /Applications/Hub/Editor/2019.4.11f1/Unity.app/Contents/Resources/ScriptTemplates)

 Si vous vous trouvez dans le bon dossier vous devriez alors voir l'ensemble des templates disponibles.

Celui qui nous intéresse ici est bien celui qui est sélectionné sur l'image ci-dessus: 81-C# Script-NewBehaviourScript.cs.txt 

Avant de continuer, pensez à faire une copie de ce fichier 

Personnaliser le template de script de l'éditeur Unity

Ouvrez dans un éditeur de texte le fameux fichier pour observer son contenu.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class #SCRIPTNAME# : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        #NOTRIM#
    }

    // Update is called once per frame
    void Update()
    {
        #NOTRIM#
    }
}

Notez les 2 tags #NOTRIM# et #SCRIPTNAME#. Le premier indique d'ajouter des tabulations, tandis que le second correspond au nom de la classe qui sera crée lors de la génération du fichier C#. Laissez ces tags et occupez vous de changer le contenu du script, par exemple en enlevant justement les commentaires inutiles ou encore en ajoutant un namespace.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

namespace EventOrizon{
    public class #SCRIPTNAME# : MonoBehaviour
    {
        void OnEnable(){
            #NOTRIM#
        }
        void Start()
        {
            #NOTRIM#
        }

        void Update()
        {
            #NOTRIM#
        }
    }
}

Une fois les modifications que vous vouliez faire sont en place, il ne reste plus qu'à sauver le fichier.

Retournez dans l'éditeur Unity et créez un nouveau script C#. En l'ouvrant dans un éditeur de code, vous devriez observer que vos modifications sont effectives .

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

namespace EventOrizon{
    public class MyScript : MonoBehaviour
    {
        void OnEnable(){
            
        }
        void Start()
        {
            
        }

        void Update()
        {
            
        }
    }
}

Et voilà, vous savez maintenant comment créer un template de script pour Unity personnalisé  . A partir de maintenant tous les nouveaux script utiliseront votre template personnalisé, super !

Pouvoir ajuster son éditeur à ses besoins concrets est toujours un must ...alors enjoy et have fun !