Template:Event/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
>Illviljan
(Created page with "{{documentation subpage}} The '''Race season''' template is used to show a race season info card. ==Parameters== {| class="wikitable" ! Parameter !! D...")
 
m (26 revisions imported)
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}


The '''Race season''' template is used to show a race season [[Template:Infocard2|info card]].
{{Lua|Module:Data_tables}}
 
The '''{{BASEPAGENAME}}''' template is used to create a infocard for events such as [[expansion]]s, [[race]]s, [[league]]s.
 
==Overview==
The template will do the following:
* Create an infocard.
* Add relevant categories to the page.
* Add cargo fields to the page.


==Parameters==
==Parameters==
All parameters should be filled in if possible to ensure it's working correctly.
{| class="wikitable"
{| class="wikitable"
! Parameter !! Description
! Parameter  
! Description
! Optional
|-
| '''name'''        || The name of the event.
| {{no}}
|-
| '''type'''        || The type of the event. Available types:
* challenge
* expansion
* pvp
* race
| {{no}}
|-
| '''release_version''' || The [[version]] the event was released.
| {{no}}
|-
| '''release_date''' || The date when the event started. Can find dates for events [http://api.pathofexile.com/leagues?type=main&compact=1 here].
| {{no}}
|-
| '''end_date'''    || The date when the event ended. Can find dates for events [http://api.pathofexile.com/leagues?type=main&compact=1 here].
| {{yes}}
|-
| '''standard'''    || Is it a standard event? Use <code>1</code> or <code>0</code>.
| {{yes}}
|-
|-
| '''name'''       || The name of the race season.
| '''hardcore'''     || Is it a hardcore event? Use <code>1</code> or <code>0</code>.
| {{yes}}
|-
| '''id'''          || Id(s) of the event. Can find the id for events [http://api.pathofexile.com/leagues?type=main&compact=1 here]
| {{yes}}
|-
|-
| '''start_date''' || The date when the race season started.
| '''number_of_events'''     || The rewards when reaching a certain point threshold during the event.
| {{yes}}
|-
|-
| '''end_date'''   || The date when the race season ended.
| '''rewards'''     || The rewards when reaching a certain point threshold during the event.
| {{yes}}
|-
|-
| '''rewards'''   || The rewards when reaching a certain point threshold during the season.
| '''prize'''       || The prize.
| {{yes}}
|-
|-
| '''prize'''     || The prize.
| '''image'''       || Custom image for the event. Defaults to <code>{{{name}}} logo.png</code> if the parameter isn't specified.
| {{yes}}
|-
|-
| '''links'''     || Relevant links for the race season.
| '''links'''       || External website of the event, preferably official web page
| {{yes}}
|}
|}


==Example==
==Cargo==
<pre>
{| class="wikitable"
{{Race season
! Table !! Declared by !! Attached by
|name = Winterheart race season
|-
|start_date = ''2016.01.29 (NZT)''
| [[Special:CargoTables/events|events]]
|end_date =
| {{tl|Event/cargo/events/declare}}
|rewards = [[Asphyxia's Wrath]] <br> [[Sapphire Ring]] <br> [[The Whispering Ice]] <br> [[Dyadian Dawn]] <br> [[Call of the Brotherhood]] <br> [[Winterheart]]
| {{tl|Event/cargo/events/attach}}
|prize = [[Demigod's Dominance]]
|}
|links = [http://www.pathofexile.com/seasons Schedule and overview]  
 
{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Data templates]]
}}
}}
</pre>
Yields:
{{Race season
|name = Winterheart race season
|start_date = ''2016.01.29 (NZT)''
|end_date =
|rewards = [[Asphyxia's Wrath]] <br> [[Sapphire Ring]] <br> [[The Whispering Ice]] <br> [[Dyadian Dawn]] <br> [[Call of the Brotherhood]] <br> [[Winterheart]]
|prize = [[Demigod's Dominance]]
|links = [http://www.pathofexile.com/seasons Schedule and overview]
}}
<includeonly>
[[Category:Infocard templates]]
</includeonly>

Latest revision as of 22:38, 11 March 2025

This subpage provides documentation for Template:Event.

Lua logo

This template uses the following modules:

The Event template is used to create a infocard for events such as expansions, races, leagues.

Overview

The template will do the following:

  • Create an infocard.
  • Add relevant categories to the page.
  • Add cargo fields to the page.

Parameters

All parameters should be filled in if possible to ensure it's working correctly.

Parameter Description Optional
name The name of the event. No
type The type of the event. Available types:
  • challenge
  • expansion
  • pvp
  • race
 No
release_version The version the event was released. No
release_date The date when the event started. Can find dates for events here. No
end_date The date when the event ended. Can find dates for events here. Yes
standard Is it a standard event? Use 1 or 0. Yes
hardcore Is it a hardcore event? Use 1 or 0. Yes
id Id(s) of the event. Can find the id for events here Yes
number_of_events The rewards when reaching a certain point threshold during the event. Yes
rewards The rewards when reaching a certain point threshold during the event. Yes
prize The prize. Yes
image Custom image for the event. Defaults to {{{name}}} logo.png if the parameter isn't specified. Yes
links External website of the event, preferably official web page Yes

Cargo

Table Declared by Attached by
events {{Event/cargo/events/declare}} {{Event/cargo/events/attach}}


Retrieved from "https://www.poe2wiki.net/index.php?title=Template:Event/doc&oldid=31398"