Template:Card template v2
- The following documentation is transcluded from Template:Card template v2/doc (edit):
Template used for card articles. See Help:Style guide/Card for more information.
Parameters[edit source]
Parameters used in Card template v2.
Parameter | Description | Type | Status | |
---|---|---|---|---|
dbfId | dbfId | The official unique numerical id of the card. Every single card must have this. For collectible cards, you can easily check its ID by looking at the links on PlayHearthstone Card Library or the Blizzard API. For example, [https://hearthstone.blizzard.com/en-us/cards/66876-rokara-the-valorous] means Rokara, the Valorous's dbfId is 66876. Use ONLY one of dbfId, id, or name to search cards.
| Number | required |
ID | id | The official string ID of the card. Use ONLY one of dbfId, id, or name to search cards.
| String | optional |
Name | name | The official name of the card. Use ONLY one of dbfId, id, or name to search cards.
| String | optional |
Related card dbfIds | derived_relatedCardDbfIds | List of the dbfIds of cards that this card generates, summons, or references (Separated by &&). For example, Kara Kazham! is a card that summons three different tokens with unique dbfIds.
| Number | optional |
Choice card dfbIds | derived_choiceCardDbfIds | List of the dbfIds of choice cards that can be chosen from this card (Separated by &&). For example, Living Roots has two choice cards that each have an unique dbfId.
| Number | optional |
Exclusions | derived_exclusions | List of exclusions where this card cannot be seen (Separated by &&). Valid options are: Arena, Card generation, Twist, Wild.
| String | optional |
Mechanics/Abilities | custom_mechanicTags | Mechanics, abilities, or keywords on the card (Separated by &&). (e.g. Taunt, Lifesteal, Draw cards, Shuffle into deck). Examples of abilities can be seen at [Help:Style guide/Tag]
| String | suggested |
Referenced mechanics | custom_refTags | Mechanics, abilities, or keywords that are referenced by the card (Separated by &&). (e.g. Taunt-granting, Stealth-generating, Rush-related). Examples of referenced tags can be seen at [Help:Style guide/Tag]
| String | suggested |
Hidden tags | custom_hiddenTags | Tags that are useful for querying, but do not need to be presented on the infobox (Separated by &&). Examples of hidden tags can be seen at [Help:Style guide/Tag]
| String | suggested |
Cycles | custom_cycles | List of cycles that this card belongs to (Separated by &&). Cycles can be small card pools that are referenced by various cards (e.g. Libram or SI:7). They can also help categorize Battlegrounds cards which tend to have inconsistent data (e.g. BG tavern token, BG removed tavern minion)
| String | optional |
Races | custom_races | The Warcraft race(s) of a minion or hero, or occasionally weapon (Separated by &&). Used for card art articles. Valid options can be seen at the bottom of any card art article (e.g. Night elf art)
| String | optional |
Background races | custom_racesInArt | Warcraft races that are on the background of a card's art, or not as the main subject, or are referenced by the art (Separated by &&). Can be used for all card types. Valid options can be seen at the bottom of any card art article (e.g. Night elf art)
| String | optional |
Character | custom_characs | The named character on the card. Used for disambiguation pages. If multiple, separated by &&.
| String | optional |
Background characters | custom_characsInArt | Named characters that are on the background of the card art, or not as the main focus of the art, or are otherwise referenced by the art (Separated by &&).
| String | optional |
Gender | custom_genders | Gender of the character on the card. Values are 0, 1, or 2, for female, male, and other.
| Number | optional |
Full art | derived_imgFullArt | The file name of the card's full art. If not declared, by default this will be "<card name> full.jpg"
| File | optional |
Signature full art | derived_imgSignatureFullArt | The file name of the card's full signature art. If not declared, by default this will be "<card name> signature full.jpg"
| File | optional |
Artist | derived_artist | The card's artist. On most collectible constructed cards, this value is stored automatically. For some uncollectible or single-player cards, it may need to be manually declared.
| String | optional |
Artist references | custom_artistReferences | If a card's artist needs citation (e.g. the artist themselves said on an external website that they're the artist of a card), the citations can be referenced here (Separated by &&)
| URL | optional |
VFX Artist | custom_vfxArtist | The artist who created the VFX effects for this card or item (NOT the drawn artwork itself).
| String | optional |
VFX Artist references | custom_vfxArtistReferences | If a card's VFX artist needs citation (e.g. the artist themselves said on an external website that they're the VFX artist of a card), the citations can be referenced here (Separated by &&)
| URL | optional |
Voice actor | custom_voiceActor | The voice actor of the card.
| String | optional |
Voice actor references | custom_voiceActorReferences | If a card's voice actor needs citation (e.g. the voice actor themselves said on an external website that they're the voice actor of a card), the citations can be referenced here (Separated by &&)
| String | optional |
Class IDs | derived_classIds | List of classes that this card belongs to (IDs of the classes, separated by &&). Most of the time, this does not need to be declared, however it may be needed for multi-class cards during reveal seasons due to incomplete data. List of class IDs can be seen at [[Template:CardsCardClass table/store1]].
| Number | optional |
Formats | derived_formats | List of constructed formats that this card belongs to (Separated by &&). Valid options are: Standard, Wild, Twist, Arena, Duels, Boss, System, Classic. Most of the time, this does not need to be declared, but may be required if the card's formats are wrong (e.g. a single-player Boss card is showing Standard in its formats).
| String | optional |
Removed | derived_isRemoved | "1" if the card is removed. May be needed if a removed card is not automatically categorized as removed.
| Number | optional |
Query only | custom_isQuery | "1" if the card only needs to be displayed along with its infobox, without storing any data. May be needed for constructed cards in Battlegrounds that are the exact same as their constructed counterpart (same dbfId)
| Number | optional |
Core set years | custom_coreInYears | List of Hearthstone years (without the "Year of the" part) that have this card in their Core set (Separated by &&). Used for Core set versions of cards only.
| String | optional |
Hearthstone Card Library link | custom_onBlizzardApi | "1" if the card can be seen in the official Hearthstone Card Library. Adds a link to the External links section of the article for the card on the card library. Usually all cards except Solo Adventure and Tavern Brawl cards can be linked to.
| Number | suggested |
HearthPwn ID | custom_hearthpwnId | ID of the HearthPwn page for the card. Adds a link to the HearthPwn page for the card on the External links section. For example, Arcane Giant's HearthPwn link is [https://www.hearthpwn.com/cards/42049]. This means that Arcane Giant's HearthPwn ID is 42049.
| Number | suggested |
Out of Games ID | custom_outOfCardsId | ID of the Out of Games page for the card. Adds a link to the Out of Games page for the card on the External links section. For example, Arcane Giant's Out of Cards link is [https://outof.games/hearthstone/cards/3022]. This means that Arcane Giant's Out of Cards ID is 3022.
| Number | suggested |
Original card dbfId | custom_originalCardDbfId | The dbfId of the card's original version. May be needed for Core or Classic cards.
| Number | optional |
Unique emotes | customFunctionalityUniqueEmote | Used for hero skins. Values are "1" or "full" if the skin has a full set of custom emotes, and "2" or "base" if the skin only has new base emotes compared to a previous skin using the same character.
| Number | optional |
Tray image | customFunctionalityUniqueTrayImage | Used for hero skins. If the skin comes with an unique tray, the image file can be pasted here to be presented on the hero skin's article.
| File | optional |
Golden tray image | customFunctionalityUniqueGoldenTrayImage | Used for hero skins. If the skin comes with an unique golden tray, the image file can be pasted here to be presented on the hero skin's article.
| File | optional |
Phone tray image | customFunctionalityUniquePhoneTrayImage | Used for hero skins. If the skin comes with an unique mobile phone tray, the image file can be pasted here to be presented on the hero skin's article.
| File | optional |
External links | custom_externalLinks | Adds additional links to the "External links" section of the article (Separated by &&)
| URL | optional |
Custom layout | article_custom | "1" or "true" if you wish that the card article should use an entirely custom layout. This disables all auto-generated sections, and the article must be written from scratch. This however does not hide the infoboxes.
| String | optional |
Pre-description | article_preDesc | An italicized and indented text, before the description.
| String | optional |
Description | article_description | The first paragraph of the article, before the first section. Usually this does not need to be changed, but can be altered for better presentation.
| String | optional |
Related cards | article_relatedCards | Used to display a custom layout for a card's related cards. By default, the related cards will simply be listed from the "Related card dbfIds" section.
| Content | optional |
Related with | article_relatedWith | Used to display a custom layout for cards this card is related with. By default, the cards it's related with will simply be listed from other cards that have this card in their "Related card dbfIds" section.
| Content | optional |
Notes | article_notes | Notes for the card (Separated by &&). Generates a "Notes" section on the article with a list format.
| Content | optional |
Tips (using) | article_tipsUsing | Tips when using this card (Separated by &&). Similar to Strategy, but avoid using filler text and follow the editing policies at [Hearthstone Wiki:Editing policies/Tips].
| Content | optional |
Tips (against) | article_tipsAgainst | Tips when playing against this card (Separated by &&). Similar to Strategy, but avoid using filler text and follow the editing policies at [Hearthstone Wiki:Editing policies/Tips].
| Content | optional |
Sounds | article_sounds | If left empty, by default, this will list the card's play, attack, and death sounds. If not left empty, a custom Sounds section layout can be written here.
| Content | optional |
Achievements | article_achievements | Uses {{Achievement query}} to get the achievements that are directly related to this card. No longer recommended from 2023, since this can be handled with [Template:CustomAchievement table], but this section may still be used for pre-2023 cards.
| Template | optional |
History | article_history | History of the card. Generates a "History" section on the article.
| Content | optional |
Lore | article_lore | Lore of the card. Generates a "Lore" section on the article.
| Content | optional |
Trivia | article_trivia | Trivia of the card, such as fun facts or information not related to Hearthstone specifically (Separated by &&). Generates a "Trivia" section on the article with a list format.
| Content | optional |
Gallery | article_gallery | Additional images, such as the character or race in WoW, or concept art (Separated by line breaks). The full art and full signature art do not need to be placed here, they are presented automatically.
| File | optional |
Videos | article_videos | Videos relating to the card. Recommended presentation is with {{#ev}} (embed video).
| Content | optional |
Trigger sounds | article_soundsCUSTOM_trigger | Exact file names of the card's triggering sounds (Separated by ,). Usually these are not declared by default, and need to be manually declared.
| File | optional |
Other sounds | article_soundsCUSTOM_other | Exact file names of the card's other sounds (Separated by ,). Usually these are not declared by default, and need to be manually declared. Mostly used for hero skins that have unique start-of-game interactions with other heroes.
| File | optional |
Trigger sound references | article_soundsCUSTOM_triggerReferences | List of references for when the triggering sound can be heard (Separated by &&). Use the same order as how you placed the trigger sound files. Usually used for hero skins.
| String | optional |
Other sound references | article_soundsCUSTOM_otherReferences | List of references for when the other sounds can be heard (Separated by &&). Use the same order as how you placed the other sound files. Usually used for hero skins.
| String | optional |
Play sound transcript | article_soundsTRANSCRIPT_play | Transcript for the card's play quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.
| String | optional |
Attack sound transcript | article_soundsTRANSCRIPT_attack | Transcript for the card's attack quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.
| String | optional |
Death sound transcript | article_soundsTRANSCRIPT_death | Transcript for the card's death quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.
| String | optional |
Trigger sound transcript | article_soundsTRANSCRIPT_trigger | Transcript for the card's trigger quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.
| String | optional |
Other sound transcript | article_soundsTRANSCRIPT_other | Transcript for the card's other quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.
| String | optional |
Metadata | article_meta | Metadata for this card, if custom metadata is required. Used for disambiguation pages.
| String | optional |