Template:CustomEventTimingEvent table/doc

From Hearthstone Wiki
Jump to navigation Jump to search

This table stores extra information Hearthstone events in Template:EventTimingEvent table.

Storing pages[edit source]

page count
Template:CustomEventTimingEvent table/store1 101

Usage[edit source]

The main purpose of this table is to present

  • data for front-end viewers, which appear on Main Page and many articles
  • data to clarify if the event is dependant on the region or not.

You put this template into Template:CustomEventTimingEvent 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.

eventName will be our primary key identifier. You can look for list of official eventNames in Template:EventTimingEvent table.

{{CustomEvent table
  |eventName=
  |startRegionDependant=
  |endRegionDependant=
  |wikiLink=
  |wikiTitle=
  |wikiHidesStartDate=
  |wikiHidesEndDate=
}}

Parameters[edit source]

Parameters used in Template:CustomEventTimingEvent table.

Template parameters

ParameterDescriptionTypeStatus
EventeventName

Codename or enum of the event. You should visit [[Template:EventTimingEvent table]] for full list of eventNames you want. This will be our primary key identifier.

Example
pre_set_rotation_2021
Stringrequired
Is start date region-dependantstartRegionDependant

1 if startDate is region dependant, then they will represent time period in America region as default. NULL if it's otherwise, which means all regions will receive the event at the same time.

Default
False
Booleanoptional
Is end date region-dependantendRegionDependant

1 if endDate is region dependant, then they will represent time period in America region as default. NULL if it's otherwise, which means all regions will receive the event at the same time.

Default
False
Booleanoptional
LinkwikiLink

Page name that describes the event in details. The event will be linked and readers/normal users can visit this link to see it.

Example
Quest#Fire Festival 2022
Stringsuggested
Wiki titlewikiTitle

Name of the event that you wish readers/normal users to see.

Example
Year of the Hydra Rotation 22.2.0 Dust Refund
Stringsuggested
Hides start datewikiHidesStartDate

1 if you want our templates not to use Start Date of the event (or considered the date empty). This is handy if you find out the date is just a temp or does not match with Hearthstone's intended design.

Booleanoptional
Hides end datewikiHidesEndDate

1 if you want our templates not to use End Date of the event (or considered the date empty). This is handy if you find out the date is just a temp or does not match with Hearthstone's intended design.

Booleanoptional