Module:Cards/doc: Difference between revisions
mNo edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
Returns the respective stat of the card.<br> | 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 challenge</code> | Possible values for <code><stat></code>: <code>name health scrap attack counter other desc summoncon tribes price gold challenge unlock</code> | ||
==Table== | ==Table== | ||
| Line 13: | Line 13: | ||
Returns a table based on the given paramenters. | Returns a table based on the given paramenters. | ||
<code><entry></code> is either a card name or type.<br> | <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</code> | 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><entry_list></code> is a list of valid <code><entry></code> values, input as multiple parameters, i.e. <code><entry1>|<entry2>|... etc.</code>. | ||
| Line 31: | Line 33: | ||
<code><template_params></code> is a list of template parameters input as multiple parameters, i.e. <code><p1>=<data1>|<p2>=<data2>|... etc.</code>. | <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]]. | 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. | Parameters without inputs are autofilled with fitting module data, to the best of its ability. | ||
Latest revision as of 02:05, 13 June 2024
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 gold challenge unlock
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 InventorsHut HotSpring Charm CursedCharm
Append a tribename before the type to filter cards exclusive to that tribe, eg SnowdwellersCompanion
<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 challenge
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 challenge is among the header stats, the table will be sorted based off the entry's ChallengeOrder value, if it exists.
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.
CharmInfobox
Usage: {{#invoke:Cards|CharmInfobox|<charm>|<template_params>}}
Returns the infobox of the charm.
<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.
Itembox
Usage: {{#invoke:Cards|Itembox|<card>|<template_params>}}
Returns the itembox 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:Itembox.
Parameters without inputs are autofilled with fitting module data, to the best of its ability.
Usage: {{#invoke:Cards|NavBoxSection|<type>}}
Returns a list of links for cards of a certain type, for use in Template:NavboxCards.
suggested values for <type>: Boss Pet NonPetCompanion Item Shade Clunker EnemyClunker Enemy Miniboss Boss