top of page
  • Writer's pictureBob Jeltes

Hoofdstuk 4: Script templates

Updated: Aug 6, 2021

Neem je toekomstige zelf en andere programmeurs werk uit handen door middel van Script Templates.


Wat zijn script templates?

Script templates zijn de standaard invulling voor bepaalde scripts. Neem bijvoorbeeld het Unity C# template script:


Wanneer je in Unity een C# script aanmaakt, werk je niet met een leeg bestand. Een aantal dingen zijn al toegevoegd:

  • Een paar using-statements

  • Een class met de aangegeven class-naam die derivet van MonoBehaviour

  • Een Start() method

  • Een Update() method

  • Comments die beschrijven welke method wat doet


Dit zijn onderdelen die je het vaakst nodig hebt bij het programmeren van een MonoBehaviour component. Het helpt beginnende programmeurs met het aan de slag gaan met het script dat gegeven is en zorgt ervoor dat als je een nieuw MonoBehaviour component maakt, je niet elke keer dezelfde dingen hoeft toe te voegen. Dit kan op lange termijn veel tijd schelen.


Hoe maak je een script template?

Voor het maken van script templates zijn twee opties:

  1. In de Unity editor folder

  2. In een map genaamd ScriptTemplates in de Assets folder van het Unity project

De namen in de ScriptTemplates folder van de Unity editor

Het script template van de Action Node


Mijn script templates spreken grotendeels voor zich. Het enige wat interessant is om uit te leggen is de #SCRIPTNAME# die twee keer in het bestand terugkomt. Dit wordt door Unity automatisch vervangen door de naam die de gebruiker het bestand geeft wanneer het in de editor wordt aangemaakt.

De locatie van de script templates in het Assets/Create-menu is afhankelijk van het getal aan het begin van de file naam. 82 zet het na C# Script en voor alles van Shader.

Met __ (twee lage strepen) tussen namen in, zorg je voor een onderverdeling. Bob Jeltes__AI zorgt er dus voor dat er een map aangemaakt wordt in Bob Jeltes met de naam AI.

De plaats van de script templates in het Create menu van Unity


Wat zet je in een script template?

Functies, alles wat er standaard in moet, en comments, comments en nog eens comments.


Als eerste is het fijn als de benodigde (bijvoorbeeld door base classes of Interfaces) of veelgebruikte functies al zijn toegevoegd aan het script. Zo hoef je als programmeur niet elke keer hetzelfde te typen en scheelt het je veel tijd.


Daarnaast is het voor externe programmeurs fijn als er een omschrijving staat van wat elk stuk van de code doet. Gebruik daarom comments om enige verwarring over de functie van bepaalde functies uit te sluiten.


Voorbeeld

Voor de behavior tree tool zijn een paar dingen van belang:

  • OnStart method

  • OnStop method

  • OnUpdate method

  • CopyData method

Deze staan dan ook standaard in aangemaakte scripts. OnStart, OnStop en OnUpdate omdat ze benodigd zijn door de Node base class. De CopyData method is automatisch toegevoegd omdat de programmeur data alle toegevoegde variabelen via deze functie moet overdragen.


Als script templates goed zijn opgezet, maak je het zelfs mogelijk voor game ontwerpers of artists om simpele scripts te schrijven indien jouw tool zich daarvoor leent, net zoals een game designer in staat wordt gesteld om een simpel Unity MonoBehaviour script te schrijven voor bijvoorbeeld het lanceren van een object.


Meer informatie

Hoe je bestaande script templates aanpast:

Deze tutorial laat alle opties zien hoe Script Templates aangemaakt kunnen worden:

 


63 views0 comments

Related Posts

See All
bottom of page