1,290
edits
Module:Cards/doc: Difference between revisions
no edit summary
(Created page with "To edit card information, see Module:Cards/data") |
No edit summary |
||
| (5 intermediate revisions by 2 users not shown) | |||
| 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 gold challenge unlock</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 InventorsHut HotSpring Charm CursedCharm</code> | |||
Append a tribename before the type to filter cards exclusive to that tribe, eg <code>SnowdwellersCompanion</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 challenge</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. | |||
If <code>challenge</code> is among the header stats, the table will be sorted based off the entry's <code>ChallengeOrder</code> value, if it exists. | |||
==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. | |||
==CharmInfobox== | |||
Usage: <code><nowiki>{{#invoke:Cards|CharmInfobox|<charm>|<template_params>}}</nowiki></code> | |||
Returns the infobox of the charm. | |||
<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. | |||
==Itembox== | |||
Usage: <code><nowiki>{{#invoke:Cards|Itembox|<card>|<template_params>}}</nowiki></code> | |||
Returns the itembox 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:Itembox]]. | |||
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]]. | |||
suggested values for <code><type></code>: <code>Boss Pet NonPetCompanion Item Shade Clunker EnemyClunker Enemy Miniboss Boss</code> | |||