Module:Interactions/doc

Ce module génère une liste des interactions possibles avec un personnage non-joueur.

Usage

Fonctions exportables :

• build(frame) – voir la documentation du modèle {{Interactions}} ;
• _build(args) – même fonction mais utilisable directement dans un autre module Lua ;

Ajouter une interaction

Il faut ajouter les lignes suivantes dans la table data :

	["nom_interaction"] = {
		checkIfYes   = true,
		image        = "",
		description  = "", -- ou function(args) ... end
		note         = ""  -- ou function(args) ... end
	},

Paramètre	Description	Type	Statut
nom_interaction	Nom du paramètre que le contributeur utilisera pour afficher l'interaction.	Chaîne	obligatoire
checkIfYes	Indique si le paramètre nom_interaction doit être égal à la valeur oui pour pouvoir être affiché.	Booléen	obligatoire
image	Nom d'un fichier illustrant l'interaction.	Chaîne	obligatoire
description	Courte description de l'interaction.	Chaîne Fonction	obligatoire
image	Sous-texte de la description, pour afficher des listes par exemple. Supprimez le paramètre si vide	Chaîne Fonction	facultatif

Exemples

Une interaction simple qui s'affiche si le contributeur appelle le paramètre fot recrue=oui.

	["fot recrue"] = {
		checkIfYes   = true,
		image        = "Icon Tour of Duty.png",
		description  = "Ce personnage est une recrue."
	},

Une interaction qui s'affiche si le contributeur renseigne une liste de factions. Cette liste est ensuite affichée dans la note.

	["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
	},

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.

	["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
	},