Différences entre les versions de « Creation Kit : Scripter »

De Wiwiki
Aller à la navigation Aller à la recherche
(Écrire le script)
(Fin de la traduction)
Ligne 2 : Ligne 2 :
[[Catégorie:Creation Kit : Tutoriels de quêtes|Scripter]]
[[Catégorie:Creation Kit : Tutoriels de quêtes|Scripter]]
[[Catégorie:Creation Kit : Quêtes|Scripter]]
[[Catégorie:Creation Kit : Quêtes|Scripter]]
{{Modèle:Travaux intenses|utilisateur=Jupotter|date=13/02/2012}}


{{Lien retour | page=[[Creation Kit : Tutoriels | Tutoriels]]}}
{{Lien retour | page=[[Creation Kit : Tutoriels | Tutoriels]]}}
Ligne 37 : Ligne 36 :


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


[[Image:CKAddNewScriptWindow.png]]
[[Image:CKAddNewScriptWindow.png]]
Ligne 44 : Ligne 42 :


[[Image:CKScriptAdded.png]]
[[Image:CKScriptAdded.png]]


=Propriétés=
=Propriétés=
Ligne 60 : Ligne 57 :


=Écrire le script=
=É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.
Maintenant que nous avons ajoutés cette propriété, nous devons ajouter le script lui même afin de faire quelque chose. Faites un clic droit sur le nom du script et sélectionnez "Edit Source" pour ouvrir l'éditeur de script.


[[File:CKScriptWindowWithPropertyAdded.png]]
[[File:CKScriptWindowWithPropertyAdded.png]]


La ligne supérieure (code>Scriptname GSQThiefScript extends ObjectReference</code>) est la base que l'éditeur a créé pour nous. Quelques lignes en dessous se trouve le texte de la propriété que nous venons de créer.
La première ligne (<code>Scriptname GSQThiefScript extends ObjectReference</code>) est la base que l'éditeur a fait pour nous quand nous avons crée le script. Quelque lignes en dessous se trouve la version textuelle de la propriété que nous avons fait.


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


<code lang="papyrus">
<nowiki>
Event OnDeath(Actor killer)
Event OnDeath(Actor killer)
TutorialQuest.SetStage(20)
TutorialQuest.SetStage(20)
EndEvent
EndEvent</nowiki>
</code>


Si vous êtes assez familier avec la programmation ou le script pour comprendre ce que vous venez de coler, vous pouvez directement passer a la section "Scripter l'Amulette". Pour les autre, on va regarder ça ligne par ligne
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 autre, nous allons voir ça lige par ligne.


* <code>Event OnDeath(Actor killer)</code>
* <code>Event OnDeath(Actor killer)</code>
** Cette ligne déclare que le script répondra ala mort de l'acteur. Quand l'acteur meurt, le jeu va executer le code a partir de ce point. Le jeu mettra celui qui à tué l'acteur dans la variable "killer", mais nous ne l'utilisons pas.
** This ligne déclare que le script va répondre a la mort de l'acteur. Quand l'acteur meurt, le jeu va commencer a exécuter le code a partir de ce point. Le jeu va placer celui qui a tué l'acteur dans la variable "killer", mais nous n'en avons pas besoins ici.
* <code> TutorialQuest.SetStage(20)</code>
* <code> TutorialQuest.SetStage(20)</code>
** Tout comme nous avons appelé <code>SetStage</code> sur la quête dans le tutoriel des dialogues, ceci va mettre la quête dans al propriété TutoriaQuest a l'étape 20.
** Tout comme nous avons appelé <code>SetStage</code> sur la quête possédant le dialogue auparavant, nous mettons ici  la quête que nous avons mit dans la propriété TutoriaQuest à l'étape 20.
** Nous indentons pour la lisibilité.
** Nous indentons pour une question de lidibilité.
* <code>EndEvent</code>
* <code>EndEvent</code>
** Ceci marque la fin de notre gestion de la mort de l'acteur.
** Cela marque la fin de notre réaction a l’événement de mort.


Sélectionnez "Save" dans le menu fichier (ou appuyez sur Ctrl-S) et l'éditeur va tenter de compiler votre script. Une fenêtre de sortie va apparaitre -- si votre script est sintaxiquement correct, elle devrais ressembler a ceci:
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 vas apparaitre -- si votre script est syntaxiquement correct, elle ressemblera a ça:


[[File:CKCompilerOutputGood.png]]
[[File:CKCompilerOutputGood.png]]


Si vous voyez autre chose, vous avez fait une erreur. Try Again!
Si vous voyez autre chose, vous avez fait une erreur en copiant. Réessayez!
 
Une fois finis, fermez la fenêtre de script et la fenêtre d'acteur, et sauvegardez votre plugin. Maintenant, il faut s'occupper de l'amelette elle même.
 
<!--
 
 
 
The top line (<code>Scriptname GSQThiefScript extends ObjectReference</code>) is boilerplate that the editor made for us when we created the script. A few lines below that is the textual version of the property we made.
 
At the bottom of the text, copy and paste the following snippet of code.
 
<source lang="papyrus">
Event OnDeath(Actor killer)
TutorialQuest.SetStage(20)
EndEvent
</source>
 
If you're familiar enough with programming or scripting that what you just pasted made sense to you, feel free to skip ahead to the "Scripting the Amulet" section. For everyone else, we'll go through line by line.
 
* <code>Event OnDeath(Actor killer)</code>
** This line declares that the script will respond to the actor dying. When the actor dies, the game will start executing the code from this point. The game will put whoever killed the actor into the "killer" variable, but that part doesn't matter to us.
* <code> TutorialQuest.SetStage(20)</code>
** Just like when we called <code>SetStage</code> on the owning quest in the dialogue tutorial, this will set stage 20 on the quest that we set with the TutorialQuest property.
** We indent it for readability.
* <code>EndEvent</code>
** This signifies the end of our handling of the death event.


Select "Save" from the file menu (or press Ctrl-S) and the editor will attempt to compile your script. An output window will pop up -- if your script is syntactically correct, it will look like this:
Une fois finis, fermez la fenêtre de script et la fenêtre d'acteur, et sauvez votre plugin. Maintenant, nous allons scripter l'amulette elle même.


[[File:CompilerOutputGood.png]]
==Scripter l'Amulette==
Ouvrez l'objet GSQAmulet que nous avons crée dans le tutoriel précedent. Dans la fenêtre d armure, la zone de script est toute a droite.


If you see anything else in there, you typed something wrong. Try again!
[[Image:CKArmorWindowScriptArea.png|600px]]


Once you're done, close the script windows and the actor window, and save your plugin. Now it's time to script the amulet itself.  
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 lieux de TutorialQuest.


=Scripting the Amulet=
[[File:CKAutofilledProperty.png]]
Open up the GSQAmulet item we created in [[Bethesda_Tutorial_Creating_an_Item|the last tutorial]]. In the armor window, the scripts area is on the far right.


[[Image:ArmorWindowScriptArea.png|600px]]
Il va remplir automatiquement la propriété pour vous, puisque la propriété a un nom qui correspond a un ID existant. Si vous utilisez beaucoup de propriétés, cela permet de gagner du temps.


Create a new script just like we did before, and call it GSQAmuletScript. Add a Quest property to it, but to see a nifty trick, call it "GSQ01" instead of "TutorialQuest" this time.
Ouvrez le script, nous allons y ajouter quelques évènement. L'amulette ne peut évidemment pas mourir, mais nous voulons savoir quand est-ce que le joueur la prend. Notre évènement devrais ressembler a ceci:


[[File:AutofilledProperty.png]]
<nowiki>
 
It automatically set the value of the property for you, since you gave the property a name that matches an existing ID. If you're declaring a lot of properties, this can save you a bunch of time.
 
Open up the script, and we're going to add an event to it. The amulet can't die (obviously), but we do want to know when the player picks it up. Our event script will look like this:
 
<code>
Event OnContainerChanged(ObjectReference newContainer, ObjectReference oldContainer)
Event OnContainerChanged(ObjectReference newContainer, ObjectReference oldContainer)
if (newContainer == Game.GetPlayer())
if (newContainer == Game.GetPlayer())
GSQ01.SetStage(30)
GSQ01.SetStage(30)
endif
endif
EndEvent
EndEvent</nowiki>
</code>


There a few things to note in this script:
Il y a certaines choses a noter dans ce script:
* The parameters in the declaration (<code>newContainer</code> and <code>oldContainer</code>) will get filled in by the game when it tells this script to handle the event.  
* Les paramètres dans la déclaration (<code>newContainer</code> and <code>oldContainer</code>) seront automatiquement remplis par le jeu quant il demandera au script de gérer l'évènement.
* Because the OnContainerChanged event will fire whenever this object changes hands, we need to make sure we only set the stage when it's the player taking it, hence the <code>if</code>/<code>endif</code> block.  
* Comme l'évènement OnContainerChanged est lancé a chaque fois que l'objet change de main, nous devons être sur de ne changer le stage que quand le joueur le prend, d'où le block <code>if</code>/<code>endif</code>.
* <code>Game.GetPlayer()</code> is a convenient way to get a reference to the player without needing to set a property, and <code>newContainer</code> was filled by the engine when this event fired, so we can do a comparison in the second line to make sure the item is moving into the player.  
* <code>Game.GetPlayer()</code> est un moyen simple d'avoir la référence du joueur sans avoir besoins de créer une propriété, et <code>newContainer</code> est remplis 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.
* The way this script is written, SetStage will be called every time the player picks up the amulet. This doesn't matter because each quest stage can only happen once - calling SetStage(30) has no effect after the first time.
* Comme le script est actuellement, SetStage est appelé a 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 que une seule fois --- Appeler SetStage(30) n'a aucun effet après la première fois.


This script is also good to go, then. Close the script and armor windows, and save your plugin.  
Le script est maintenant près. Fermez le script est la fenêtre de l'amulette, et sauvegardez votre plugin.


You can now play through the quest from start to finish, checking the console with [[ShowQuestVars|SQV]] to see its stage changing.  
Vous pouvez maintenant tester votre quête du début a la fin, en utilisant la console et SQV (<code>SQV GSQ001</code>) pour voir l'étape changer.


Players can't use the console, though, so we'll learn how to give them better feedback about the quest in the next chapter.  
Mais les joueurs ne vont pas utiliser la console, nous allons donc apprendre a leur donner de meilleurs indications de leur progrès dans le prochain chapitre.


::{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
::{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|-
|style="border-style: solid; border-width: 0"|[[Image:Protip.jpg|48px]]
|style="border-style: solid; border-width: 0"|[[Image:CKProtip.jpg|48px]]
|style="border-style: solid; border-width: 0"|The scripts for Skyrim are just text files that live in your data directory before they get compiled into bytecode. This means that if you've got a favorite text editor, you can use it to work on scripts. We've included setups for both [[Sublime Text Setup|Sublime Text]] and [[Notepad++ Setup|Notepad++]] that provide syntax highlighting, some basic autocompletion, and compilation shortcuts. If you're going to get heavily into scripting, these tools can make your life a lot easier.  
|style="border-style: solid; border-width: 0"|Les scripts dans Skyrim sont de simple fichier texte dans votre dossier Data avant d'être compilés en bytecode. Cela signifie que si vous avez un éditeur de texte favoris, vous pouvez l'utiliser pour scripter. Le wiki officiel possède quelques exemples de configuration qui permet la coloration syntaxique, une autocompletion basique et des raccourcis de compilation. Si vous allez scripter intensément, ces outils peuvent vraiment vous simplifier la vie.
|}
|}
-->


{{Navigation|tag=Creation Kit|parent=Tutoriels|actuel=Scripter|précédent=Créer un objet|suivant=Scripter }}
{{Navigation|tag=Creation Kit|parent=Tutoriels|actuel=Scripter|précédent=Créer un objet|suivant=Scripter }}

Version du 13 mars 2012 à 08:17



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 a un acteur ou a 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 a 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 simple fichier texte qui sont compilés en bytecode que le jeu exécute au runtime.

CKNewFeature.jpg 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 interrompus 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ée, la quête progresse.

Ajouter des Scripts

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

CKActorWindowScriptsArea.png

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

CKAddScriptWindow.png

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

CKAddNewScriptWindow.png

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

CKScriptAdded.png

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 a propos des objets du jeu autre que celui auquel ils sont attachés. Nous utilisons les propriétés afin d'attaches des objets ensemble pour qu'ils puissent s'affecter les un 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.

CKEmptyPropertiesWindow.png

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, sois choisissez "Quest" dans le menu, sois tapez le mot "Quest". Mettez "TutorialQuest" dans le champ Name, et laissez le reste vide.

CKAddScriptPropertyWindow.png

Nous avons maintenant dit au script que 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" a droit de la fenêtre. Un nouveau menu va apparaitre, listant toute les quêtes du jeu. Choisissez "GSQ01" dans le menu, et appuyez sur OK.

CKPropertyWindowFilled.png

É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.

CKScriptWindowWithPropertyAdded.png

La première ligne (Scriptname GSQThiefScript extends ObjectReference) est la base que l'éditeur a fait pour nous quand nous avons crée le script. Quelque 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 autre, nous allons voir ça lige par ligne.

  • Event OnDeath(Actor killer)
    • This ligne déclare que le script va répondre a la mort de l'acteur. Quand l'acteur meurt, le jeu va commencer a exécuter le code a partir de ce point. Le jeu va placer celui qui a tué l'acteur dans la variable "killer", mais nous n'en avons pas besoins 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 mit dans la propriété TutoriaQuest à l'étape 20.
    • Nous indentons pour une question de lidibilité.
  • EndEvent
    • Cela marque la fin de notre réaction a 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 vas apparaitre -- si votre script est syntaxiquement correct, elle ressemblera a ça:

CKCompilerOutputGood.png

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

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

Scripter l'Amulette

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

CKArmorWindowScriptArea.png

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 lieux de TutorialQuest.

CKAutofilledProperty.png

Il va remplir automatiquement la propriété pour vous, puisque la propriété a un nom qui correspond a 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ènement. L'amulette ne peut évidemment pas mourir, mais nous voulons savoir quand est-ce que le joueur la prend. Notre évènement devrais ressembler a ceci:

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

Il y a certaines choses a noter dans ce script:

  • Les paramètres dans la déclaration (newContainer and oldContainer) seront automatiquement remplis par le jeu quant il demandera au script de gérer l'évènement.
  • Comme l'évènement OnContainerChanged est lancé a chaque fois que l'objet change de main, nous devons être sur 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 besoins de créer une propriété, et newContainer est remplis 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é a 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 que une seule fois --- Appeler SetStage(30) n'a aucun effet après la première fois.

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

Vous pouvez maintenant tester votre quête du début a 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 a leur donner de meilleurs indications de leur progrès dans le prochain chapitre.

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