Éditeur de scripts
L'Éditeur de scripts est l'endroit où vous écrivez le code Enforce Script d'un mod (les fichiers .c) et son
config.cpp, et où vous lisez les scripts du jeu pour apprendre comment on fait telle chose. Il vérifie
le code pendant la frappe, complète les noms, montre la déclaration de ce que vous survolez, et saute vers
n'importe quelle classe ou méthode du jeu ou de votre mod. Il vous faut un dossier de mod (un « workspace ») pour écrire
du code, et le dossier DayZ défini dans les Paramètres pour parcourir les scripts du jeu ; lire les scripts du jeu
fonctionne sans aucun mod.
L'écran
- Panneau de gauche, trois onglets.
- Explorateur : les dossiers de votre ou vos mods sur le disque. Cliquez sur un fichier pour l'ouvrir. Le champ de filtre restreint les fichiers par nom, le bouton + crée un script, le bouton en forme de lien ouvre le mod dans un éditeur externe (VS Code par défaut). Clic droit sur un fichier ou un dossier pour Nouveau script, Nouveau dossier, Ouvrir dans l'éditeur externe, Renommer et Supprimer (Supprimer demande un second clic).
- Vanilla : l'arborescence des scripts du jeu, lue depuis le
scripts.pbodu jeu. « Vanilla » désigne le jeu non modifié. Les fichiers s'ouvrent en lecture seule. - Symboles : une recherche dans chaque classe, méthode, champ et enum du jeu et de votre mod. Saisissez au moins deux caractères ; un clic ouvre le fichier à la déclaration. La ligne sous le champ indique si l'index des scripts est prêt.
- Le ? à droite des onglets ouvre cette aide (F1 fait la même chose).
- Onglets de fichiers (en haut du milieu) : un onglet par fichier ouvert. Un point signale des modifications non enregistrées ; les fichiers du jeu portent « lecture seule ». Fermez avec la croix ou un clic du milieu.
- Ligne de chemin : le chemin du fichier actif, la position du curseur, le langage et le bouton Enregistrer.
- Bandeau lecture seule (scripts du jeu uniquement) : indique que le fichier ne peut pas être modifié et propose Copier dans mon mod.
- Éditeur : le code. Les problèmes sont soulignés ; les points d'arrêt se posent dans la gouttière à gauche des numéros de ligne.
- Panneau du bas (réduit à une barre tant que vous ne cliquez pas dessus) :
- Problèmes : erreurs et avertissements de tous les fichiers ouverts, puis les erreurs de script trouvées dans le journal de script ou le RPT le plus récent du jeu. Un clic ouvre le fichier à la ligne.
- Références : les usages d'un symbole, après Maj+F12 dans l'éditeur.
Dmarque une déclaration,Run usage. - Débogage : le débogueur de scripts (écoute, boutons Continuer et Pas à pas, pile d'appels, variables, et une console qui exécute de l'Enforce Script dans le jeu).
- Structure (à droite, quand un fichier est ouvert) : les classes du fichier et leurs membres. Cliquez sur l'un d'eux pour y aller.
Premiers pas
- Ouvrez la page et cliquez sur l'onglet Vanilla.
- Sous
scripts, ouvrez4_World,Entities,ManBaseet cliquez surPlayerBase.c. Il s'ouvre en lecture seule. - Dans la Structure, cliquez sur une méthode pour y aller. Survolez un nom de type pour voir sa déclaration ; appuyez sur F12 (ou Ctrl+clic) sur un nom pour sauter à l'endroit où il est défini.
- Cliquez sur l'onglet Symboles, saisissez
MissionServeret cliquez sur la classe : un autre fichier du jeu s'ouvre à la déclaration. - Revenez à Explorateur. S'il indique qu'il n'y a pas de workspace, ajoutez le dossier de votre mod ou créez un mod depuis le modèle. Puis cliquez sur +, gardez « modded class », saisissez un nom de fichier et créez-le.
- Saisissez du code, surveillez la barre Problèmes en bas, et enregistrez avec Ctrl+S.
Faire la visite (dans l'app)
Tâches courantes
Créer un script dans votre mod
- Dans l'Explorateur, cliquez sur + (ou faites un clic droit sur le dossier où le fichier doit aller, puis Nouveau script).
- Choisissez le module de script (
3_Game,4_Worldou5_Mission), saisissez le nom du fichier, choisissez le contenu : unemodded class(modifier une classe du jeu), uneclass(une nouvelle classe) ou un fichier vide. - Vérifiez le chemin affiché en bas de la boîte de dialogue, puis Créer.
Le fichier va dans Scripts/<module>/<mod id>/<name>.c du mod (l'orthographe des dossiers existants
est conservée). Si le module n'est pas déclaré dans le bloc CfgMods du config.cpp du mod, la page
l'ajoute et vous le dit ; sans cette déclaration, le jeu ne charge pas le dossier.
Modifier une classe du jeu (modded class)
- Trouvez la classe avec l'onglet Symboles et ouvrez-la.
- Lisez la méthode que vous voulez changer et notez sa signature.
- Cliquez sur Copier dans mon mod dans le bandeau lecture seule (la copie va dans le même module
de script de votre mod ; gardez ensuite seulement ce que vous changez et écrivez
modded classdevant la classe), ou créez un nouveau script avec le contenu « modded class » et le même nom de classe. - Écrivez l'
overridede la méthode ; appelezsuper.<Method>(...)quand l'original doit tout de même s'exécuter. - Enregistrez, puis vérifiez la liste Problèmes.
Faire la visite de cette tâche (dans l'app)
Trouver où quelque chose est défini ou utilisé
- Placez le curseur sur un nom. F12 ou Ctrl+clic mène à sa définition (aussi dans les scripts du jeu).
- Maj+F12 liste chaque usage dans l'onglet Références du panneau du bas.
- Pour un nom que vous n'avez pas à l'écran, utilisez l'onglet Symboles.
Corriger les erreurs de script de la dernière exécution du jeu
- Lancez le jeu ou le serveur avec votre mod (page Launcher).
- Revenez ici et ouvrez le panneau du bas : sous les problèmes de vos fichiers, la section « Journal du jeu » liste les erreurs de compilation et les exceptions de script du journal le plus récent, chacune avec son nombre.
- Cliquez sur l'une d'elles : le fichier de votre mod s'ouvre à la ligne fautive. Corrigez, enregistrez, relancez.
Les avertissements du journal ne sont listés que pour les fichiers de votre propre mod.
Déboguer un script avec des points d'arrêt
- Ouvrez l'onglet Débogage du panneau du bas et cliquez sur Écouter (port par défaut 41001).
- Lancez la version de diagnostic du jeu, DayZDiag, avec
-debuggerPort=<port>, ou utilisez « Attacher le débogueur de scripts » dans le Launcher. Le badge passe à « connecté ». - Cliquez à gauche d'un numéro de ligne (ou appuyez sur F9) pour poser un point d'arrêt. Quand le jeu l'atteint, la ligne est mise en évidence et la pile d'appels et les variables se remplissent.
- F5 continue, F10 passe par-dessus, F11 entre dans la fonction, Maj+F11 en sort.
- « Rechargement à chaud à l'enregistrement » recompile un script enregistré dans le jeu en cours d'exécution (le jeu doit être lancé
avec
-filePatching).
Partir d'une recette
Sans fichier ouvert, l'état vide montre les recettes de cette page en puces (Nouveau mod, Téléporter les nouveaux joueurs, Nouvelle recette d'artisanat…) : un clic en lance une dans Beans Assistant, qui pose quelques questions, propose un plan et avance étape par étape avec des vérifications. Toutes les recettes ouvre tout le catalogue. Le panneau d'aide (F1) les liste aussi.
Exemples
- PlayerBase : le joueur (dans l'app) : la classe de chaque survivant et la classe du jeu la plus modée.
Regardez sa longueur, et utilisez la Structure pour atteindre
OnConnectouEEKilled. - MissionServer : ce que fait le serveur (dans l'app) :
OnInit, les événements client (OnClientNewEvent,InvokeOnConnect,InvokeOnDisconnect), etCreateCharacter/StartingEquipSetup, qui décident de ce que porte un personnage qui vient d'apparaître. - Canteen : une petite classe d'objet (dans l'app) :
class Canteen extends Bottle_Base, une poignée de méthodesoverriderenvoyant des noms de sound sets, etCanPutInCargoappelantsuperen premier. - ActionDrink : une action du joueur (dans l'app) : le constructeur définit la classe de callback, la commande
d'animation et le texte ;
CreateConditionComponentsdéfinit les conditions sur l'objet et la cible ; la classe de callback définit la durée.
Concepts
- Enforce Script : le langage de script de DayZ, dans des fichiers
.c(ce n'est pas du C). Classes, héritage simple,override,super, variables typées. Référence : Enforce Script Syntax. - Modules de script : le jeu compile ses scripts en cinq couches,
1_Core,2_GameLib,3_Game,4_World,5_Mission, dans cet ordre. Le code d'un module ne voit que les classes du sien et des modules inférieurs. Un mod ajoute des fichiers à3_Game,4_Worldet5_Mission; une modded class doit se trouver dans le module de la classe qu'elle modifie. - Modded class :
modded class PlayerBase { ... }ajoute des membres à une classe existante ou remplace ses méthodes, sans modifier le fichier du jeu. Plusieurs mods peuvent modder la même classe ; chaque appel àsuperatteint le précédent dans l'ordre de chargement. - config.cpp et CfgMods : le
config.cppd'un mod déclare le mod (CfgPatches) et, dansCfgMods, un blocclass defsavec une entrée par module de script (gameScriptModule,worldScriptModule,missionScriptModule) nommant le dossier à compiler. Un dossier qui n'y est pas déclaré est ignoré par le jeu. Voir Modding Basics. - PBO : le format d'archive que charge le jeu. Les scripts du jeu sont dans
dta/scripts.pbo; votre mod est empaqueté en PBO par le Packer PBO. Cette page lit les PBO et ne les écrit jamais. - DayZDiag : l'exécutable de diagnostic livré avec le jeu. Le débogueur de scripts de cette page
écoute sur un port et DayZDiag s'y connecte quand il est lancé avec
-debuggerPort=<port>.
Pièges
- Essayer de modifier un script du jeu : le fichier est en lecture seule et Enregistrer est désactivé. Utilisez Copier dans mon mod ou une modded class.
- Laisser dans le mod un fichier du jeu copié en entier : le jeu trouve alors chaque classe en double. Après
Copier dans mon mod, ne gardez que les classes que vous changez, sous forme de
modded class. - Mettre une modded class dans le mauvais module (une classe de
4_Worldmoddée depuis5_Mission) : Copier dans mon mod garde le module du fichier du jeu ; dans la boîte Nouveau script, choisissez-le vous-même. - Oublier de déclarer un module de script dans
config.cpp: la page ajoute l'entrée quand elle crée un script, et avertit quand le fichier n'a pas de blocCfgMods/class defsoù l'ajouter. - Un override dont la signature diffère de l'original : lisez la liste Problèmes avant d'empaqueter.
- Modifier le même fichier dans VS Code et ici : les fichiers modifiés à l'extérieur sont rechargés ; quand l'onglet a des modifications non enregistrées, un bandeau propose Recharger depuis le disque ou Garder ma version, et Enregistrer attend le choix.
- Les anciens scripts qui ne sont pas en UTF-8 sont ouverts en Latin-1 et réenregistrés de la même façon ; les caractères
hors Latin-1 deviennent
?(un avertissement le signale à l'ouverture du fichier). - La liste Problèmes ne couvre que les fichiers ouverts. Vérifiez tout le mod avec
script_check, ou lisez le journal du jeu après une exécution.
Pour les agents
Outils de dzt qui font le même travail sans la fenêtre :
script_symbols: recherche approximative de classes, méthodes, champs, enums et globales dans les scripts du jeu et les workspaces de mods (Class.membercherche des membres). Même index que l'onglet Symboles.script_class: une classe en entier : où elle est déclarée, classes de base, déclarations moddées, sous-classes, membres avec signatures. Utilisez-le avant d'écrire un override.script_grep: recherche par expression régulière dans les scripts du jeu et les dossiers de mods (appelants, chaînes littérales).script_check: erreurs de syntaxe et avertissements sémantiques de chaque script d'un dossier de mod. Lancez-le après modification, avant d'empaqueter.vfs_search,vfs_read: trouver et lire un fichier du jeu par chemin virtuel (par exemplescripts/4_world/entities/manbase/playerbase.c).config_check: diagnostics d'unconfig.cpp(la page lance les mêmes vérifications sur une config ouverte).file_read,file_edit,file_write,file_move,file_delete: les fichiers propres au mod.mod_new: un nouveau mod depuis le modèle.logs_tail,fix_scan: les journaux du jeu et leurs erreurs.debug_listen,debug_status,debug_set_breakpoints,debug_wait,debug_control,debug_variables,debug_exec,debug_recompile,debug_log: le débogueur de scripts.
Fichiers que la page lit et écrit :
- Lit : les dossiers de workspace (Paramètres), les PBO du jeu via le système de fichiers virtuel
(
dta/scripts.pbopour l'onglet Vanilla), lescript_*.logou.RPTle plus récent des dossiers de profil du jeu. - Écrit : uniquement dans un dossier de workspace : le script que vous enregistrez (même encodage qu'à la lecture), les nouveaux
scripts et dossiers, les renommages et suppressions, et l'entrée
CfgModsajoutée auconfig.cppdu mod. Les fichiers du jeu ne sont jamais écrits. - Un document est identifié par son chemin sur le disque, ou par
vfs:<chemin virtuel>pour un fichier du jeu. Une demande d'ouverture avec un cheminvfs:ouvre ce fichier du jeu en lecture seule.
Ce que la page dit à l'assistant (son contexte de page) : le fichier actif (chemin ou clé vfs:), la
ligne du curseur, le nombre d'onglets ouverts, si le fichier a des modifications non enregistrées, et ses problèmes sous la forme
line N: severity message. Sans fichier ouvert, le contexte est vide. Elle propose une action : relire
le fichier ouvert.
Voir aussi
- Config (CfgConvert) : convertir et vérifier les fichiers de config.
- Éditeur de layouts : les fichiers d'UI que vos scripts chargent ; Comment fonctionne DZML.
- Packer PBO : empaqueter le mod une fois les scripts propres.
- Launcher : lancer le jeu ou un serveur local avec le mod, attacher le débogueur.