Navigation: Page dédiée aux créateurs de mission du site de documentation VEAF

🚧 TRAVAUX EN COURS 🚧

La documentation est en train d’être retravaillée, morceau par morceau. En attendant, vous pouvez consulter l’ancienne documentation.

Table des matières

Introduction

Le module Combat Zone permet de créer facilement des zones qu’on peut déclencher à la demande, et qui peuvent contenir des groupes DCS (unités sol, navires, hélicoptères) - avec leurs waypoints et leurs instructions, des commandes VEAF (comme celles qu’on peut déclencher dans un marqueur sur la carte F10).

Principes

Une Combat Zone est constituée de :

Une fois configurée, une entrée sera ajoutée dans le menu radio VEAF, comprenant ces commandes:

Le menu radio est sécurisé ; par défaut il faut être connecté (/secu login) pour pouvoir activer ou désactiver des zones (sauf celles qui sont en mode “entrainement”).

Et enfin, il faut ajouter la zone nouvellement créée à la bibliothèque des combat zones, en utilisant la fonction veafCombatZone.AddZone.

Configuration d’une Combat Zone

Déclarer une Combat Zone dans le fichier de configuration

Tout commence dans le fichier de configuration de la mission missionConfig.lua, qui est situé dans le répertoire src/scripts de votre mission.

Ce dernier est un fragment de code source LUA qui permet de choisir la manière dont les scripts VEAF sont activés et configurés. Nous vous conseillons d’utiliser Notepad++ ou Visual Studio Code pour l’éditer.

Par défaut, si vous avez utilisé le convertisseur de mission existante pour préparer votre dossier de mission VEAF, il contient déjà un modèle de configuration QRA que vous pourrez trouver en cherchant -- configure COMBAT ZONE.

Le principe de configuration est simple.

Tout d’abord on crée un “objet” de type VeafCombatZone en appelant VeafCombatZone:new(). Cet appel renvoie une instance de VeafCombatZone, qu’on peut stocker dans une variable (local maZone = VeafCombatZone:new()) ou utiliser tout de suite avec une désignation chaînée (en enchainant les appels aux méthodes de configuration qui renvoient toutes, tour à tour, la même instance de VeafCombatZone).

Exemple de chainage

VeafCombatZone:new()
    :setMissionEditorZoneName("combatZone_CrossKobuleti")
 :setFriendlyName("Cross Kobuleti")

L’avantage de cette méthode est sa simplicité.

Exemple d’utilisation d’une variable

local zoneCrossKobuleti = VeafCombatZone:new()
zoneCrossKobuleti:setMissionEditorZoneName("combatZone_CrossKobuleti")
zoneCrossKobuleti:setFriendlyName("Cross Kobuleti")

L’avantage de la seconde méthode est qu’on peut, plus loin dans le fichier missionConfig.lua, utiliser une référence à la variable qu’on a définie pour accéder à l’instance de VeafCombatZone (par exemple, dans la définition d’un alias, d’une commande “mission maker”, ou dans un menu radio).

Paramètres obligatoires

Définition du nom technique de la zone

Ce nom sert à retrouver la Combat Zone avec la commande veafCombatZone.GetZone(); exemple: veafCombatZone.GetZone("combatZone_CrossKobuleti")

:setMissionEditorZoneName("combatZone_CrossKobuleti")

Description de la zone

C’est ce qui sera repris dans les différents messages et dans le menu radio

:setFriendlyName("Cross Kobuleti")

Définition du briefing

:setBriefing("A BTR patrol and a few manpads are dispersed around the Batumi airbase")

Pour définir le briefing sur plusieurs lignes, le plus simple est d’utiliser les “double brackets”:

:setBriefing([[This is a simple mission
You must destroy the comm antenna
The other ennemy units are secondary targets]])

Paramètres optionnels

Mode “entrainement”

En mode entrainement, la zone est accessible à tous (pas de sécurisation du menu radio), les informations détaillent le nombre et le type d’unités restantes, et les balises fumigènes sont centrées sur le barycentre des ennemis restants (sinon, au centre de la zone).

:setTraining(true)

Nettoyage des carcasses

Par défaut, à la désactivation d’une zone, les carcasses de véhicules et les cadavres sont automatiquement nettoyés. Cela peut être désactivé:

:disableJunkCleanup()

Activation de la zone

On peut choisir de laisser les utilisateurs activer la zone, ou pas ; pour ça on utilise:

:enableUserActivation()

:disableUserActivation()

Fumigènes et fusées d’éclairage

Par défaut, ces options sont activées sur toutes les zones. On peut changer ça en utilisant setEnableSmokeAndFlare ; par exemple:

setEnableSmokeAndFlare(true)

Options relatives au menu radio

Désactivation du menu radio

Si on le souhaite, on peut désactiver les menus radio d’une Combat Zone.

:disableRadioMenu()
Préfixe du menu radio

On peut ajouter un préfixe aux entrées de menu radio, pour faciliter la lecture.

En effet, les zones actives sont marquées par un astérisque dans le menu radio, et donc elles sont groupées.

Le nom des menus radio est : <astérisque (ou pas)> . Par exemple:

Pour définir un préfixe, on peut utiliser la fonction setRadioMenuPrefix ; exemple:

:setRadioMenuPrefix("Kobuleti - ")
Groupes de menus radio

On peut grouper les combat zones dans le menu radio. Pour ce faire, il faut utiliser la fonction setRadioGroupName ; exemple:

:setRadioGroupName("Batumi")

Toutes les combat zones qui partagent le même groupe radio seront reprises dans un sous-menu nommé comme le groupe.

Informations sur les unités

Si on souhaite que le message d’informations de la zone ne comprenne pas la liste des unités (ou juste le résumé, si la zone n’est pas en mode entrainement), on peut utiliser:

:setShowUnitsList(false)

Informations sur la position et la météo de la zone

Si on souhaite que le message d’informations de la zone ne comprenne pas la position de la zone ni la météo sur place, on peut utiliser:

:setShowZonePositionInfo(false)

Surveillance de la destruction des unités

Les unités concernées par une Combat Zone sont en permanence surveillées. En pratique, toutes les quelques secondes, on lance une vérification de l’état de la zone et des unités.

On vérifie l’état des unités IA spawnées dans le cadre de la zone ; si elles sont toutes détruites la zone est considérée comme terminée, et elle est automatiquement désactivée après un message explicatif

Par défaut, si toutes les unités ennemies de la zone sont détruites, on affiche un message et on la désactive. Si on souhaite désactiver ça, on peut utiliser:

:setCompletable(false)

Enchainement des combat zones

Il est possible de paramétrer une chaine de combat zones qui vont s’activer automatiquement l’une après l’autre, la suivante s’activant dès que la précédente est terminée.

Pour ça, on utilise les fonctions addChainedCombatZone et (optionnellement) setChainedCombatZonesDelay.

Si on configure plusieurs zones “suivantes” pour une zone donnée, celle qui sera effectivement activée est choisie au hasard.

Par exemple, pour obtenir une progression comme:

Il faut faire comme suit:

local zone1 = 
  VeafCombatZone:new()
  :setMissionEditorZoneName("zone1")
  :addChainedCombatZone("zone2")
local zone2 = ...
  VeafCombatZone:new()
  :setMissionEditorZoneName("zone2")
  :addChainedCombatZone("zone2_1")
  :addChainedCombatZone("zone2_2")
  :setChainedCombatZonesDelay(20) -- attendre 20 secondes avant de lancer la zone suivante
local zone2_1 = ...
  VeafCombatZone:new()
  :setMissionEditorZoneName("zone2_1")
  :addChainedCombatZone("zone3")
local zone2_2 = ...
  VeafCombatZone:new()
  :setMissionEditorZoneName("zone2_2")
  :addChainedCombatZone("zone3")
local zone3 = ...
  VeafCombatZone:new()
  :setMissionEditorZoneName("zone3")
  -- pas de "chained combat zone"

Options disponibles dans le nom de l’unité

Groupes de spawn et choix aléatoire

Le cas d’usage est celui-ci: on souhaite placer quelques unités (par exemple des manpads) dans la zone, et on veut que leur emplacement soit aléatoire. Mais on souhaite que tous les emplacements possibles soient définis manuellement, pour avoir le contrôle sur le lieu où les unités vont spawner.

Pour faire ça, il suffit de placer une unité sur chaque emplacement possible. Toutes les unités doivent avoir le préfixe “#spawngroup” dans leur nom, avec le même nom de groupe. Et ils doivent également avoir le préfixe “#spawnchance” pour quantifier la chance que chaque emplacement soit choisi (en principe, on met une chance identique à chaque emplacement - 100 divisé par le nombre d’emplacements - mais rien n’empêche d’en privilégier certains). Et enfin, “#spawncount” indique le nombre d’emplacements qui seront activés.

Exemple avec un spawn de 2 manpads sur 4 emplacements possibles:

Le dernier emplacement de manpad a 2 fois plus de chances que les autres d’être sélectionné.

Rayon de spawn

Par défaut, un groupe (ou une commande) spawn à l’endroit exact où l’unité a été placée dans l’éditeur de mission.

Mais si on veut introduire un peu de suspense, on peut utiliser “#spawnradius” pour définir un rayon (en mètres) dans lequel le spawn aura lieu.

Exemple: cz_Psebay_manpad_001 #spawnradius=250 -> le manpad spawnera à un endroit aléatoire dans un rayon de 250m autour du point où l’unité a été posée.

Délai avant le spawn

En principe, tous les groupes sont spawnés et toutes les commandes VEAF sont exécutées dès l’activation de la combat zone.

Mais il est possible de retarder le spawn d’un groupe ou l’exécution d’une commande en utilisant l’option “#spawndelay” (en secondes).

Exemple: cz_Psebay_manpad_001 #spawndelay=60 -> le manpad ne spawnera qu’après 60 secondes

Autre exemple: cz_Psebay_artillery_mission_001 #command="-shell" #radius=500 #spawndelay=120 -> après 2 minutes, une frappe d’artillerie visera un point aléatoire dans un rayon de 500 mètres

Commandes VEAF

Pour définir une commande VEAF, il faut utiliser dans le nom de l’unité l’option “#command” suivie de la commande à exécuter.

Toutes les commandes qu’on peut mettre dans un marqueur sur la vue F10 sont valides.

Cela inclut évidemment tous les spawns (comme -armor, -transport, -afac) mais aussi les spawns aériens (-cap mig-29 par exemple), et toutes les commandes qui pourraient sembler incongrues dans ce contexte (-secu login mot_de_passe ou -point nom_du_point, ou encore _move tanker, name Texaco).

Exemple: cz_Psebay_armor_001 #command="-armor, size 10, defense 1-3, armor 3-5"

Personnalisation

Hooks

Appel d’une fonction quand la combat zone est terminée

Pour appeler une fonction quand la combat zone est terminée, il suffit d’utiliser setOnCompletedHook.

La fonction en paramètre sera appelée dès que la zone est terminée (tous les ennemis sont détruits).

Cette fonction doit accepter un paramètre qui sera la combat zone elle-même.

Voici un exemple:

--- cette fonction sera appellée quand la zone "Gori" est terminée
function onGoriEnd(zone)
    trigger.action.outText(string.format("Hook on %s", zone:getFriendlyName()), 10)
end

local gori = VeafCombatZone:new()
    :setMissionEditorZoneName("subCombatZone_gori")
    :setFriendlyName("Mission Gori")
    :setBriefing("Destroy the armored group in the city of Gori")
    :setOnCompletedHook(onGoriEnd) -- on paramètre le hook
    :initialize()
    :setTraining(false)

Exemple de la zone “Psebay factory” dans l’OpenTraining Caucase

Le code dans missionConfig.lua:

veafCombatZone.AddZone(
  VeafCombatZone:new()
    :setMissionEditorZoneName("combatZone_Psebay_Factory")
    :setFriendlyName("Psebay chemical weapons factory")
    :setRadioGroupName("Missions")
    :setBriefing(
[[This factory manufactures chemical weapons for a terrorist group
You must destroy both factory buildings, and the bunker where the scientists work
"The other enemy units are secondary targets]])
)

La trigger zone et les unités dans l’éditeur de mission:

Trigger Zone dans l'éditeur

Le détail d’une unité qui déclenchera une commande VEAF (ici avec des options):

Étiquettes de nom d'unité avec balises

Le menu radio de cette zone de combat:

Menu radio COMBAT ZONES

Contacts

Si vous avez besoin d’aide, ou si vous voulez suggérer quelque chose, vous pouvez :