62 737
modifications
« Module:Interactions/doc » : différence entre les versions
aucun résumé des modifications
Page créée avec « Ce module implémente le modèle {{m|Interactions}}. <includeonly> Catégorie:Espace Module </includeonly> <noinclude> Catégorie:Documentation de module </noincl… » |
Aucun résumé des modifications |
||
| Ligne 1 : | Ligne 1 : | ||
Ce module | Ce module génère une liste des interactions possibles avec un personnage non-joueur. | ||
== Usage == | |||
Fonctions exportables : | |||
* <code>build(frame)</code> – voir la documentation du modèle {{m|Interactions}} ; | |||
* <code>_build(args)</code> – même fonction mais utilisable directement dans un autre module Lua ; | |||
== Ajouter une interaction == | |||
Il faut ajouter les lignes suivantes dans la table <code>data</code> : | |||
<syntaxhighlight lang="lua"> | |||
["nom_interaction"] = { | |||
checkIfYes = true, | |||
image = "", | |||
description = "", -- ou function(args) ... end | |||
note = "" -- ou function(args) ... end | |||
}, | |||
</syntaxhighlight> | |||
{| class="wikitable" | |||
! Paramètre !! Description !! Type !! Statut | |||
|- | |||
| <code>nom_interaction</code> || Nom du paramètre que le contributeur utilisera pour afficher l'interaction. || Chaîne || obligatoire | |||
|- | |||
| <code>checkIfYes</code> || Indique si le paramètre <code>nom_interaction</code> doit être égal à la valeur <code>oui</code> pour pouvoir être affiché. || Booléen || obligatoire | |||
|- | |||
| <code>image</code> || Nom d'un fichier illustrant l'interaction. || Chaîne || obligatoire | |||
|- | |||
| <code>description</code> || Courte description de l'interaction. || Chaîne<br/>Fonction || obligatoire | |||
|- | |||
| <code>image</code> || Sous-texte de la description, pour afficher des listes par exemple. Supprimez le paramètre si vide || Chaîne<br/>Fonction || facultatif | |||
|} | |||
=== Exemples === | |||
Une interaction simple qui s'affiche si le contributeur appelle le paramètre <code>fot recrue=oui</code>. | |||
<syntaxhighlight lang="lua"> | |||
["fot recrue"] = { | |||
checkIfYes = true, | |||
image = "Icon Tour of Duty.png", | |||
description = "Ce personnage est une recrue." | |||
}, | |||
</syntaxhighlight> | |||
Une interaction qui s'affiche si le contributeur renseigne une liste de factions. Cette liste est ensuite affichée dans la note. | |||
<syntaxhighlight lang="lua"> | |||
["factions"] = { | |||
checkIfYes = false, | |||
image = "Terrifying Presence.png", | |||
description = "Ce personnage est allié avec les factions suivantes.", | |||
note = function(args) return LF .. args["factions"] .. LF end | |||
}, | |||
</syntaxhighlight> | |||
Une interaction dont la description est une fonction, ce qui permet d'afficher ou non l'aptitude procurée par le compagnon selon les informations renseignées par le contributeur. | |||
<syntaxhighlight lang="lua"> | |||
["compagnon permanent"] = { | |||
checkIfYes = true, | |||
image = "FO76 ui casual team.png", | |||
description = function(args) | |||
local description = "Ce personnage est un [[compagnon]] permanent." | |||
local perk = args["aptitude"] | |||
if perk then | |||
description = description .. " Il procure l'aptitude " .. perk .. '.' | |||
end | |||
return description | |||
end | |||
}, | |||
</syntaxhighlight> | |||
<includeonly> | <includeonly> | ||