Module:Cards/doc: Difference between revisions

From Wildfrost Wiki
Jump to navigation Jump to search
(Created page with "To edit card information, see Module:Cards/data")
 
No edit summary
Line 1: Line 1:
To edit card information, see [[Module:Cards/data]]
To edit card information, see [[Module:Cards/data]]
==GetStat==
Usage: <code><nowiki>{{#invoke:Cards|GetStat|<card>|<stat>}}</nowiki></code>
Returns the respective stat of the card.<br>
Possible values for <code><stat></code>: <code>name health scrap attack counter other desc summoncon tribes price</code>
==Table==
Usage: <code><nowiki>{{#invoke:Cards|Table|<entry>|<header_list>}}</nowiki></code> OR<br>
<code><nowiki>{{#invoke:Cards|Table|<entry_list>|*|<header_list>}}</nowiki></code>
Returns a table based on the given paramenters.
<code><entry></code> is either a card name or type.<br>
Types include: <code>Boss Pet NonPetCompanion Companion Item Shade Clunker EnemyClunker Enemy Miniboss Boss ShopItem</code>
<code><entry_list></code> is a list of valid <code><entry></code> values, input as multiple parameters, i.e. <code><entry1>|<entry2>|... etc.</code>.
<code><header_list></code> is a list of valid stats, input as multiple parameters, i.e. <code><stat1>|<stat2>|... etc.</code>.<br>
Stats include: <code>name health scrap attack counter other desc summoncon tribes price</code>
The first usage option is used when only 1 entry is needed, e.g. the only entry is a type category. Otherwise, use the second option.
==CardInfobox==
Usage: <code><nowiki>{{#invoke:Cards|CardInfobox|<card>|<template_params>}}</nowiki></code>
Returns the infobox of the card.
<code><template_params></code> is a list of template parameters input as multiple parameters, i.e. <code><p1>=<data1>|<p2>=<data2>|... etc.</code>.
These parameters are the same parameters used by [[Template:Infobox]].
Parameters without inputs are autofilled with fitting module data, to the best of its ability.
==NavBoxSection==
Usage: <code><nowiki>{{#invoke:Cards|NavBoxSection|<type>}}</nowiki></code>
Returns a list of links for cards of a certain type, for use in [[Template:NavboxCards]].
possible values for <code><type></code>: <code>Boss Pet NonPetCompanion Companion Item Shade Clunker EnemyClunker Enemy Miniboss Boss ShopItem</code>

Revision as of 15:54, 17 December 2023

To edit card information, see Module:Cards/data

GetStat

Usage: {{#invoke:Cards|GetStat|<card>|<stat>}}

Returns the respective stat of the card.
Possible values for <stat>: name health scrap attack counter other desc summoncon tribes price

Table

Usage: {{#invoke:Cards|Table|<entry>|<header_list>}} OR
{{#invoke:Cards|Table|<entry_list>|*|<header_list>}}

Returns a table based on the given paramenters. <entry> is either a card name or type.
Types include: Boss Pet NonPetCompanion Companion Item Shade Clunker EnemyClunker Enemy Miniboss Boss ShopItem

<entry_list> is a list of valid <entry> values, input as multiple parameters, i.e. <entry1>|<entry2>|... etc..

<header_list> is a list of valid stats, input as multiple parameters, i.e. <stat1>|<stat2>|... etc..
Stats include: name health scrap attack counter other desc summoncon tribes price

The first usage option is used when only 1 entry is needed, e.g. the only entry is a type category. Otherwise, use the second option.

CardInfobox

Usage: {{#invoke:Cards|CardInfobox|<card>|<template_params>}}

Returns the infobox of the card.

<template_params> is a list of template parameters input as multiple parameters, i.e. <p1>=<data1>|<p2>=<data2>|... etc.. These parameters are the same parameters used by Template:Infobox. Parameters without inputs are autofilled with fitting module data, to the best of its ability.

NavBoxSection

Usage: {{#invoke:Cards|NavBoxSection|<type>}}

Returns a list of links for cards of a certain type, for use in Template:NavboxCards.

possible values for <type>: Boss Pet NonPetCompanion Companion Item Shade Clunker EnemyClunker Enemy Miniboss Boss ShopItem