Template:CustomReward table/doc

From Hearthstone Wiki
Jump to navigation Jump to search

This template allows you store new data of rewards that are not present in client Hearthstone to CustomReward table. Some of these types of rewards include:

  • Shop items (excluding Regular and Golden Mini-set bundles)
  • Log-in triggers
  • Owning a certain type of pack triggers
  • Invite a Friend triggers
  • New player's ranked system rewards
  • Free Deck choices
  • Promotion from Twitch Gaming, YouTube, other games, and so on

CustomReward table will be used mainly on Reward and articles that contain How to get section.

List of storing pages[edit source]

Usage[edit source]

You put this template into Template:CustomReward table/store1 or any storing templates in the above section. You can also create a new one if you like, as long as it is not in main namespace.

{{CustomReward table
 |targetPages=
 |howToGet=
 |costRaw=
 |costGold=
 |costDust=
 |costRunestone=
 |costArcaneOrb=
 |rewards=
 |type=
 |variation=
 |quantity=
 |startDate=|startDateText=
 |endDate=|endDateText=
 |is_regionDependant=
 |refs=
}}

Parameters[edit source]

Parameters used in Template:CustomReward table.

Template parameters

ParameterDescriptionTypeStatus
List (&&) of target pagestargetPages

List of wiki pages where you want to appear in their How to get section, separated by &&.

Example
Mercenaries/Tyrael&&Blademaster Okani
Stringrequired
How to gethowToGet

Methods to get the rewards. Written in commnand sentences but no period at the end of sentence. Can only contain 1000 characters or less.

Example
Claim for free in Shop
Stringrequired
Real costcostRaw

Float number of cost of the reward(s) in dollar in America store/shop.

Example
14.99
Numbersuggested
Gold costcostGold

Integer number of amount of Gold the reward(s) require.

Example
2000
Numbersuggested
Dust costcostDust

Integer number of amount of Arcane Dust the reward(s) require.

Example
1600
Numbersuggested
Runestone costcostRunestone

Integer number of number of Runestones the reward(s) require.

Example
1500
Numbersuggested
Arcane Orb costcostArcaneOrb

Integer number of number of Arcane Orbs the reward(s) require.

Example
180
Numbersuggested
Rewardsrewards

Name of the rewards. Doesn't need to specify the quantity of the rewards, and also premium variation (Golden, Diamond, Regular) if it's a card. This key is only displayed in Reward article.

Example
Mercenary Tyrael

Golden Standard pack

Blademaster Okani
Stringrequired
typetype

Type of the reward. Card pack, Card, Hero skin, Board, Emote, Strike, Mini-set,...

Example
Card pack
Stringrequired
Variationvariation

Variation of the reward. Regular, Golden, or Diamond if it's a card or a mini-set. If it's a mercenary, you need to specify its variation id. Used mainly in How to get section of "targetPages".

Example
Regular
Stringsuggested
Quantityquantity

Number of the rewards.

Example
1
Numbersuggested
Starting datestartDate

The date when it was first available for claim. Written in ISO 8601 format, time included, UTC timezone. Overrides "startDateText".

Example
2020-01-01 17:00:00
Datesuggested
Starting date by textstartDateText

The moment when it was first available for claim, but you don't remember the exact date. Will be overriden by "startDate" if it is defined.

Example
Patch 24.0
Stringsuggested
Ending dateendDate

The date when it is no longer available. Written in ISO 8601 format, time included, UTC timezone. Overrides "endDateText".

Example
2020-01-01 17:00:00
Datesuggested
Ending date by textendDateText

The moment when it is no longer available, but you don't remember the exact date. Will be overriden by "endDate" if it is defined.

Example
Patch 24.0
Stringsuggested
Is region dependantis_regionDependant

True if the dates may vary based on the region you are playing in.

Default
NULL
Booleanoptional
List (&&) of referencesrefs

References of the rewards, separated by &&. Recommended using {{Cite web}} or {{tw}} if possible.

Example
{{cite web|url=https://playhearthstone.com/news/23797164|title=23.4 Patch Notes|author=Blizzard Entertainment|work=PlayHearthstone|date=2022-31-05|accessdate=2022-01-06}}
Stringsuggested

Examples[edit source]

Logging in reward[edit source]

{{CustomReward table
 |targetPages=Blademaster Okani
 |howToGet=Log in [[Hearthstone]]
 |rewards=[[Blademaster Okani]]
 |type=Card
 |variation=Regular
 |quantity=1
 |startDate=2022-03-17 17:00:00
 |endDateText=Patch 24.0
 |refs=[[Patch 22.6.0.133923]]
}}

Bundle reward[edit source]

In case there are bundles with various type of items (variations), you might need to create separated data for them, but keep the howToGet criteria the same.

{{CustomReward table
 |targetPages={{#lstmap:Neptulon&&Arch-Host Rafaam&&Captain Party-Crasher&&Ice Sculptor Chenvaala&&Disco Drek'thar&&Traybough&&Party Animal Mukla&&Baz'hial, Unlife of the Party&&Hot Mess Mutanus&&Captive Guest Nozdormu&&Disco Pyramad&&Grand Entrance Reno&&Skating Silas&&Dancin' Tamsin&&Xyrella the Elegant&&Yogg-Saron, Punch Guardian|&&|@@|Battlegrounds/@@|&&}}
 |howToGet=Purchase Battlegrounds Mega Bundle - Eternal Night
 |costRaw=29.99
 |rewards=15 {{Bl|Hero skin|Battlegrounds skins}} + 1 {{Bl|Neptulon}}
 |type=Hero skin
 |variation=Regular
 |quantity=
 |startDate=2022-06-07 17:00:00
 |endDate=2022-06-27 17:00:00
 |refs=https://us.shop.battle.net/en-us/product/hearthstone-battlegrounds-mega-bundle-eternal-nights
}}{{CustomReward table
 |targetPages=Battlegrounds/Disco Dynamite
 |howToGet=Purchase Battlegrounds Mega Bundle - Eternal Night
 |costRaw=29.99
 |rewards={{Bl|Disco Dynamite}} Strike
 |type=Strike
 |quantity=1
 |startDate=2022-06-07 17:00:00
 |endDate=2022-06-27 17:00:00
 |refs=https://us.shop.battle.net/en-us/product/hearthstone-battlegrounds-mega-bundle-eternal-nights
}}{{CustomReward table
 |targetPages=Battlegrounds/Karazhan Forever
 |howToGet=Purchase Battlegrounds Mega Bundle - Eternal Night
 |costRaw=29.99
 |rewards={{Bl|Karazhan Forever}} Board
 |type=Board
 |quantity=1
 |startDate=2022-06-07 17:00:00
 |endDate=2022-06-27 17:00:00
 |refs=https://us.shop.battle.net/en-us/product/hearthstone-battlegrounds-mega-bundle-eternal-nights
}}