Modification de Module:Fiche de créature/doc

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 [[Module:Infobox|Infobox]].

== Usage ==

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

Par exemple le modèle {{m|Fiche de créature de Fallout}}} contient <code><nowiki>{{#invoke:Fiche de créature|build|nom=Fallout}}</nowiki></code>, 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 ===

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.

<syntaxhighlight lang="lua">
{
    parts = {} -- contient les différentes parties de la fiche de créature
}
</syntaxhighlight>

La table <code>parts</code> 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

<syntaxhighlight lang="lua">
{ type = "table", title = "", rows = {} }
</syntaxhighlight>

{| class="va-table va-table-full"
! Paramètre !! Type !!  Obligatoire !!Description
|-
| <code>title</code> || string || Non || Un en-tête pour le tableau
|-
| <code>rows</code> || table || Oui || Table contenant des tables de type <code>row</code> et qui définissent les lignes du tableau à générer
|}

<syntaxhighlight lang="lua">
{ type = "row", label = "", icon = "", value = "" }
</syntaxhighlight>

{| class="va-table va-table-full"
! Paramètre !! Type !!  Obligatoire !!Description
|-
| <code>label</code> || function<br/>string || Oui || Le libellé de la ligne
|-
| <code>icon</code> || string || Oui || Nom d'une icône définie dans le modèle {{m|Icône}}.
|-
| <code>value</code> || function<br/>string || Oui || Paramètre que l'utilisateur renseignera.
|}

;Liste

<syntaxhighlight lang="lua">
{ type = "list", title = "", prefix = "", max = 0 }
</syntaxhighlight>

{| class="va-table va-table-full"
! Paramètre !! Type !!  Obligatoire !!Description
|-
| <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.
|}

<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.
|}
<includeonly>[[Catégorie:Module Fiche de créature| ]]</includeonly><noinclude>[[Catégorie:Documentation de module]]</noinclude>