Module:Fiche/doc

De Binding of Isaac: Rebirth Wiki
Aller à : navigation, rechercher

Ceci est la page de documentation pour Module:Fiche

Template-info.png Documentation

Fonction mode( f, listeModes ) [modifier le wikicode]

Cette fonction met en place la structure d'un module fiche.
ArgumentsRenvois
f (frame)
  • Frame de la page utilisée.
  • Nécessite trois paramètres, en plus de ceux spécifiques à chaque fiche :
    disp (string)
    • Mode d'affichage, utilisé lors d'une transclusion. Doit avoir pour valeur {{{2}}}.
    temp (string)
    • Nom de l'élément auquel la fiche est dédiée, utilisé lors d'une transclusion. Doit avoir pour valeur {{{1}}}.
    nom (string)
    • Nom de l'élément auquel la fiche est dédiée.
  • Toute valeur nulle sur ou syntaxe non respectée sur l'un de ces trois paramètres nuira directement au bon fonctionnement des Fiches.
listeModes (string)
  • Liste des modes utilisés par la fiche, séparés par  /  :
    • case
    • nom
    • tableau
    • tableauSimple (nécessite tableau)
    • phraseIntro
    • Le mode fiche est présent par défaut et n'a pas besoin d'être ajouté.
  • Type : (function)
  • Fonction correspondant au mode demandée de la fiche correspondante.
  • Renvoie deux arguments :
    args (table)
    • Renvoyé par la fonction args( f ) de la fiche correspondante.
    page (table)
  • Renvoie une valeur (string) si le mode demandé dans disp n'existe pas.

Fonction nom( nom, remplaceNom, mode ) [modifier le wikicode]

Cette fonction gère l'affichage du titre d'une fiche.
ArgumentsRenvois
nom (string)
  • Valeur de l'argument nom contenu dans le tableau args de la fonction mode( f, listeModes ).
remplaceNom (string)
  • Texte à afficher, s'il est différent de la valeur de nom.
  • Peut prendre une valeur nulle.
mode (int)
  • Apparence du titre à renvoyer :
    • 0 ou nil renvoie le texte avec la police TeamMeat de la fonction titre( police, texte, taille ) du Module:Police.
    • 1 renvoie le contenu du paramètre |lien= d'une image MediaWiki.
    • 2 renvoie le titre avec un lien vers la page correspondante. À utiliser sur des transclusions.
    • 3 renvoie le titre sans autre modification.
  • Type : (string)
  • Dépend de la valeur de l'argument mode.

Fonction image( nom, remplaceNom, remplaceImage, _t, lien, _sD, _sF, _e ) [modifier le wikicode]

Cette fonction renvoie un fichier selon les paramètres entrés par l'utilisateur.
ArgumentsRenvois
nom (string)
  • Valeur de l'argument nom contenu dans le tableau args de la fonction mode( f, listeModes ).
remplaceNom (string)
  • Texte à afficher sur le fichier, s'il est différent de la valeur de nom.
  • Peut prendre une valeur nulle.
remplaceImage (string)
  • Nom du fichier, sans l'espace de nom, l'extension et les chaînes de caractères supplémentaires s'il est différent de la valeur de nom.
  • Peut prendre une valeur nulle.
_t (string)
  • Taille initiale du fichier en pixels (ex. : 60x60px).
lien (boolean)
  • Indique si le fichier doit avoir un lien.
_sD (string)
  • Caractères à ajouter avant le nom du fichier (ex. : Boss_).
_sF (string)
  • Caractères à ajouter après le nom du fichier, avant l'extension (ex. : _App).
_e (string)
  • Optionnel. Extension initiale du fichier (ex. : .gif).
  • Prend pour valeur .png si sa valeur est nulle.
  • Type : (string)
  • Fichier au format MediaWiki.

Fonction citation( citation, italique ) [modifier le wikicode]

Cette fonction affiche la citation d'un élément.
ArgumentsRenvois
citation (string)
  • Citation en anglais.
  • Pour la citation traduite en français, entrer : vo(CitationEN) vf(CitationFR).
italique (boolean)
  • Optionnel. Indique si le texte doit être en italique.
  • Type : (string)

Fonction recharge( recharge, mode ) [modifier le wikicode]

Cette fonction affiche la recharge d'un objet activable.
ArgumentsRenvois
recharge (string)
  • Type de recharge :
    • 1, 2, 3, 4, 6 ou 12.
    • utilisation unique pour un objet disparaissant après utilisation.
    • infinie pour un objet sans recharge.
    • 6s pour un objet se rechargeant au fil du temps.
mode (int)
  • Apparence de la recharge à renvoyer :
    • 0 ou nil renvoie l'image de la recharge et le texte associé.
    • 1 renvoie l'image de la recharge de grande taille.
  • Type : (string)

Fonction grilleCollection( grille, maxColonne, maxLigne, texte ) [modifier le wikicode]

Cette fonction renvoie une grille de collection, la case demandée sélectionnée.
ArgumentsRenvois
grille (string)
  • Position de la case à sélectionner.
  • Entrer la page, la colonne puis la ligne, en séparant les valeurs par un espace.
maxColonne (int)
  • Nombre de colonnes à afficher dans la grille.
maxLigne (int)
  • Nombre de lignes à afficher dans la grille.
texte (boolean)
  • Optionnel. Indique si l'emplacement de la case sélectionné doit être écrit au-dessus de la fiche.
  • Type : (string)

Ceci est une page documentaire, elle devrait être transcluse dans le modèle principal. Voir Modèle:Doc pour de plus amples renseignements.