Creation Kit : Scripter

Tutoriel traduit du wiki officiel: Original

Résumé

Ce tutoriel va vous montrer comment utiliser les scripts pour faire avancer la quête suivant les actions du joueur. On a déjà vu comment scripter un dialogue, mais ici, nous allons voir comment attacher n'importe quel script à un acteur ou à un objet.

Vous allez apprendre:

• Les généralités sur le fonctionnement des scripts et comment ils s'attachent aux objets dans le Creation Engine.
• Comment répondre à un évènement dans le nouveau langage de scripts.

Papyrus

Le langage de scripts utilisé par le Creation Kit est appelé Papyrus (d'après ce qui compose les parchemins). Les scripts Papyrus sont de simples fichiers textes qui sont compilés en bytecode que le jeu exécute au runtime.

Le nouveau système est similaire au TESScript, mais requière une manière de penser légèrement différente. Vous ne pouvez plus directement manipuler les objets dans le mode; il y a maintenant des thread, votre script peut alors être interrompu en fonctionnement; il est beaucoup plus script en ce qui concerne la syntaxe (e.g. parenthèses). Pour faire court, il est beaucoup plus proche de "vrais" langages de programmation comme le Lua ou Python. Si vous êtes familier avec le TESScript, vous devriez jeter un œil a notre guide de transition.

La première chose que nous allons faire est ajouter un script sur notre voleur afin que lorsqu'il est tué, la quête progresse.

Ajouter des Scripts

Ouvrez l'acteur GSQThief que nous avons créé. Nous allons nous intéresser à la section "Papyrus Scripts" de la fenêtre.

Cliquez sur le bouton "Add". Cela va ouvrir une liste de scripts que nous pouvons potentiellement ajouter à cet acteur. Mais nous sommes en train d'en créer un nouveau, double-cliquez donc sur "[New Script]" en haut de la liste.

Cela ouvrira encore une fenêtre, où nous pouvons nommer notre script. Mettez donc "GSQThiefScript" puis appuyez sur OK.

Votre script est maintenant ajouté à l'acteur. Mais, comme on peut s'y attendre, il ne fait encore rien.

Propriétés

Double-cliquez sur le script pour ouvrir la fenêtre des propriétés de ce script. De base, les scripts ne savent rien à propos des objets du jeu autre que celui auquel ils sont attachés. Nous utilisons les propriétés afin d'attacher des objets ensemble pour qu'ils puissent s'affecter les uns les autres. Dans notre exemple, nous voulons passer GSQ01 à l'étape 20 lorsque le voleur est tué, il faut donc que le script sache quelle quête nous intéresse.

Appuyez sur "Add Property" en bas à gauche de la fenêtre. C'est ici que nous allons créer la propriété. Dans le champ Type, soit choisissez "Quest" dans le menu, soit tapez le mot "Quest". Mettez "TutorialQuest" dans le champ Name, et laissez le reste vide.

Nous avons maintenant dit au script qu'il doit utiliser quelque chose qui s’appelle "TutorialQuest", mais il ne sait pas de quelle quête il s'agit. Cliquez sur la propriété que nous venons de créer dans la liste, et cliquez sur "Edit Value" à droite de la fenêtre. Un nouveau menu va apparaitre, listant toutes les quêtes du jeu. Choisissez "GSQ01" dans le menu, et appuyez sur OK.

Écrire le script

Maintenant que nous avons ajouté cette propriété, nous devons ajouter le script en lui même pour en faire quelque chose!, Faites un clic droit sur le nom du script et sélectionnez "Edit source" pour ouvrir l'éditeur de script.

La première ligne (Scriptname GSQThiefScript extends ObjectReference) est la base que l'éditeur a fait pour nous quand nous avons créés le script. Quelques lignes en dessous se trouve la version textuelle de la propriété que nous avons fait.

À la fin du texte, copiez et collez ce morceau de code:

Event OnDeath(Actor killer)
	TutorialQuest.SetStage(20)
EndEvent

SI vous êtes suffisamment connaisseur en programmation ou en scripting pour comprendre ce que vous venez de coller, vous pouvez directement aller à la section "Scripter l'Amulette". Pour tous les autres, nous allons voir ça ligne par ligne.

• Event OnDeath(Actor killer)
  • Cette ligne déclare que le script va répondre à la mort de l'acteur. Quand l'acteur meurt, le jeu va commencer à exécuter le code à partir de ce point. Le jeu va placer celui qui a tué l'acteur dans la variable "killer", mais nous n'en avons pas besoin ici.
• TutorialQuest.SetStage(20)
  • Tout comme nous avons appelé SetStage sur la quête possédant le dialogue auparavant, nous mettons ici la quête que nous avons mis dans la propriété TutoriaQuest à l'étape 20.
  • Nous indentons pour une question de lisibilité.
• EndEvent
  • Cela marque la fin de notre réaction à l’événement de mort.

Sélectionnez "Save" dans le menu "File" (ou faites Ctrl-S) et l'éditeur va tenter de compiler votre script. Une fenêtre de sortie va apparaitre -- si votre script est syntaxiquement correct, elle ressemblera à ça:

Si vous voyez autre chose, vous avez fait une erreur en copiant. Réessayez!

Une fois fini, fermez la fenêtre de script et la fenêtre d'acteur, et sauvegardez votre plugin. Maintenant, nous allons scripter l'amulette elle même.

Scripter l'Amulette

Ouvrez l'objet GSQAmulet que nous avons créés dans le tutoriel précédent. Dans la fenêtre d'armure, la zone de script est toute à droite.

Créez un nouveau script comme nous l'avons fait auparavant, et appelez-le GSQAmuletScript. Ajoutez-lui une propriété de Quête. Pour simplifier les choses, appelez-la directement "GSQ01" au lieu de TutorialQuest.

Il va remplir automatiquement la propriété pour vous, puisque la propriété a un nom qui correspond à un ID existant. Si vous utilisez beaucoup de propriétés, cela permet de gagner du temps.

Ouvrez le script, nous allons y ajouter quelques évènements. L'amulette ne peut évidemment pas mourir, mais nous voulons savoir quand est-ce que le joueur la prend. Notre évènement devrait ressembler à ceci :

Event OnContainerChanged(ObjectReference newContainer, ObjectReference oldContainer)
	if (newContainer == Game.GetPlayer())
		GSQ01.SetStage(30)
	endif
EndEvent

Il y a certaines choses à noter dans ce script:

• Les paramètres dans la déclaration (newContainer and oldContainer) seront automatiquement remplis par le jeu quand il demandera au script de gérer l'évènement.
• Comme l'évènement OnContainerChanged est lancé à chaque fois que l'objet change de main, nous devons être sûr de ne changer le stage que quand le joueur le prend, d'où le block if/endif.
• Game.GetPlayer() est un moyen simple d'avoir la référence du joueur sans avoir besoin de créer une propriété, et newContainer est rempli par le moteur lorsque l'évènement est lancé. On peut donc facilement comparer pour voir si l'objet est bien pris par le joueur.
• Comme le script est actuellement, SetStage est appelé à chaque fois que le joueur prend l'amulette. Ce n'est pas un problème, car chaque étape de quête ne peut se passer qu'une seule fois --- Appeler SetStage(30) n'a aucun effet après la première fois.

Le script est maintenant prêt. Fermez le script et la fenêtre de l'amulette, et sauvegardez votre plugin.

Vous pouvez maintenant tester votre quête du début à la fin, en utilisant la console et SQV (SQV GSQ001) pour voir l'étape changer.

Mais les joueurs ne vont pas utiliser la console, nous allons donc apprendre à leur donner de meilleures indications de leurs progrès dans le prochain chapitre.

Les scripts dans Skyrim sont de simples fichiers textes dans votre dossier Data avant d'être compilés en bytecode. Cela signifie que si vous avez un éditeur de texte favori, vous pouvez l'utiliser pour scripter. Le wiki officiel possède quelques exemples de configuration qui permettent la coloration syntaxique, une autocomplétion basique et des raccourcis de compilation. Si vous allez scripter intensément, ces outils peuvent vraiment vous simplifier la vie.