« Module:Fiche de créature/doc » : différence entre les versions

Navigation interactive dans l’historique

Dernière version du 13 février 2022 à 00:08

Ce module est un générateur de fiche de créature dont la structure est définie dans sous-module. Structurellement, il s'agit d'une réadaptation du module Infobox.

Usage[modifier le wikicode]

build(frame) est la seule fonction exportable. Elle ne prend en entrée que le paramètre nom, le nom du sous-module dans lequel est défini la structure de la fiche de créature.

Par exemple le modèle {{Fiche de créature de Fallout}}} contient {{#invoke:Fiche de créature|build|nom=Fallout}}, indiquant qu'il faut charger Module:Fiche de créature/Fallout. Les paramètres passés au modèle sont disponibles dans Module:Fiche de créature/Localdata qui lui-même peut être appelé dans les sous-modules pour générer des structures plus complexes.

Structure du sous-module[modifier le wikicode]

La structure de la fiche de créature est définie par une table contenue dans un sous-module dont le format est le suivant.

{
    parts = {} -- contient les différentes parties de la fiche de créature
}

La table parts contient elle-même d'autres tables qui définissent le type de structure à générer. Il est possible de définir deux types de structure, des tableaux ou des listes.

Table

{ type = "table", title = "", rows = {} }

Paramètre	Type	Obligatoire	Description
`title`	string	Non	Un en-tête pour le tableau
`rows`	table	Oui	Table contenant des tables de type `row` et qui définissent les lignes du tableau à générer

{ type = "row", label = "", icon = "", value = "" }

Paramètre	Type	Obligatoire	Description
`label`	function string	Oui	Le libellé de la ligne
`icon`	string	Oui	Nom d'une icône définie dans le modèle {{Icône}}.
`value`	function string	Oui	Paramètre que l'utilisateur renseignera.

Liste

{ type = "list", title = "", prefix = "", max = 0 }

Paramètre	Type	Obligatoire	Description
`title`	string	Oui	Un en-tête pour la liste
`prefix`	string	Oui	Préfixe du paramètre pour les éléments de la liste
`max`	number	Oui	Nombre maximal d'éléments dans la liste

@@ Ligne 50 : / Ligne 50 : @@
 <syntaxhighlight lang="lua">
-{ type = "list", title = "", items = {} }
+{ type = "list", title = "", prefix = "", max = 0 }
 </syntaxhighlight>
@@ Ligne 58 : / Ligne 58 : @@
 | <code>title</code> || string || Oui || Un en-tête pour la liste
 |-
-| <code>items</code> || table || Oui || Table contenant des tables de type <code>item</code> et qui définissent les éléments de la liste.
+| <code>prefix</code> || string|| Oui || Préfixe du paramètre pour les éléments de la liste
-|}
-<syntaxhighlight lang="lua">
-{ type = "item", value = "" }
-</syntaxhighlight>
-{| class="va-table va-table-full"
-! Paramètre !! Type !!  Obligatoire !!Description
 |-
-| <code>value</code> || function<br/>string || Oui || Paramètre que l'utilisateur renseignera.
+| <code>max</code> || number || Oui || Nombre maximal d'éléments dans la liste
 |}
-<includeonly>[[Catégorie:Module]]</includeonly><noinclude>[[Catégorie:Documentation de module]]</noinclude>
+<includeonly>[[Catégorie:Module Fiche de créature| ]]</includeonly><noinclude>[[Catégorie:Documentation de module]]</noinclude>