Template:SoloPrizePool

From Liquipedia Commons Wiki

Documentation (view - edit)

A call to this Module will create a Prize Pool Table based on given information.

A call consist of two sections. First there is the Header, which contains settings and meta information of the table, such as which prizes types are available and whether it's a team or solo table. Secondly there is a set of Slots, where each slot represents a set of opponents that finished in the same placement. Each slot has one or more Opponents in it.


Usage

Header

|type=
(Required) A valid opponent, for instance |type={{TeamOpponent}}. Using Template:TeamPrizePool automatically sets the type to TeamOpponent.
|autoexchange=true
(Optional) Set to false to turn off the automatic conversion from local currencies into USD.
|prizesummary=true
(Optional) Set to false to hide the summary text above the table. The information is retrieved from the Template:Infobox league.
|exchangeinfo=true
(Optional) Set to false to hide the currency exchange information after the table. If |autoexchange=false this is unused.
|cutafter=4
(Optional) How many opponents to show before hiding behind the toggle. It will never be broken in the middle of a slot.
|syncPlayers=1
(Optional) Set to 1 to sync player's flags if the player pages exist.
|localcurrencyX=
(Optional) X is an ascending integer, starting at 1. |localcurrency1=EUR would indicate that there is a Euro Prizepool.
|percentage=
(Optional) Allows specifying the prize as a percentage of the total prize pool. Set to true to enable. If enabled, the prize money is automatically calculated using the total prize pool and the specified percentage for each slot.
|pointsX=
(Optional) X is an ascending integer, starting at 1. Available point types can be found in a wikis Module:Points/data. |points1=dpc would indicate that there are Dota Pro Circuit points to be gain.
|qualifiesX=
(Optional) X is an ascending integer, starting at 1. Value should be a tournament one or more teams qualifies to. |qualifies1=PGL/Arlington_Major/2022 (dota2) means that one or more teams will qualify to the Arlington Major.
|qualifiesXname=
(Optional) Overrides the display name in the PrizePool table for this qualification. By default it's automatically retrieved from the tournament page, but for instance if that tournament does not yet exists, this field becomes (Required).
|qualifiesXicon=
(Optional) Only used if the tournament page does not yet exist. Supply an icon to show.
|qualifiesXicondark=
(Optional) Only used if the tournament page does not yet exist. Supply a dark mode icon to show.
|freetextX=
(Optional) X is an ascending integer, starting at 1. Freetext can be anything that are not any of the above types. Example |freetext1=Hardware.

Import options

|import=
(Optional) Set to true to turn on the automatic import from the page the prize pool is used on.
(Optional) Set to false to turn off the automatic import IFF no matchGroupId and no tournament is specified.
Wikis may adjust the behaviour of this via Module:PrizePool/Custom.
|matchGroupIdX=
(Optional) matchGroup id for which to import data. If set it will also enable the import.
Needs to be a valid match2bracketid.
To import a match group not in main space, use the namespace prefixed ID, e.g. |matchGroupIdX=User_GenericUser Name_D2pPke4HGQ. (Include spaces in the username.)
|tournamentX=page
(Optional) A list of tournaments to import data from. Each argument value is the page name of a tournament. If set it will also enable the import. |tournamentX=# is shorthand for the current page.
The tournament order determines placement order. Opponents eliminated from tournaments later in the list have higher (better) placements.
To import from a tournament not in main space, use the namespace prefixed full page name, e.g. |tournament1=User:GenericUser Name/Sea Duckling Open/104. (Include spaces in the username.)
|tournamentX=Page#Stage
(Optional) Imports data from a stage of a tournament (e.g. Group Stage or Playoffs) instead of the entire tournament. If set it will also enable the import. To make this work, first deliminate the tournament structure in the tournament page. This is done by wrapping each stage's section header with {{Stage}} like so: ==={{Stage|...}}===. Then, |tournamentX=Page#Stage will import only from that stage. Page can be omitted if the stage is on the current page.
|importLimit=
(Optional) Limit on the number of entries/opponents imported.
If more slots are entered manually the importLimit is automatically upped to that value unless disabled by setting |placementsExtendImportLimit=true
Wikis may set default values for this.
|placementsToSkip=
(Optional) Number of placements that should not be imported.
|stageXimportLimit=
(Optional) Limit on the number of entries/opponents imported for the respective {{Stage}}.
Functioned the same way as |importLimit=
|stageXimportWinners=
(Optional) Enable/Disable importing Winners for the respective {{Stage}}.
|stageXplacementsToSkip=
(Optional) Number of placements that should not be imported from the respective {{Stage}}.
|groupElimStatuses=
(Optional) Set group statuses that are treated as elimination values.
By default only down is considered.
example: |groupElimStatuses=down,staydown
|stageXgroupElimStatuses=
(Optional) Set group statuses that are treated as elimination valuesfor the respective {{Stage}}.
Functioned the same way as |groupElimStatuses=
|shiftPlacementsBy=
(Optional) Shift the imported placements/slots by a provided number of slots.
Import options to be set via /Custom
|groupScoreDelimiter=
(Optional) The delimiter with which group scores are separated in storage.
Default is /
If wikis want to change this they should set it via Module:PrizePool/Custom
|allGroupsUseWdl=
(Optional) If set to true this will make GSL and Swiss style groups store with wdl instead of lastVs
Default is false
If wikis want to change this they should set it via Module:PrizePool/Custom

Slot

Each rank gets their own Slot. A slot contain a set of opponents (1 or more) that share final placement.

|count=
(Optional) The size (count/amount of opponents in the slot) of the slot. By default this is automatically calculated.
|place=
(Optional) The place for all teams of this slot. By default this is automatically calculated.
|dnp=false
(Optional) Set to true to indicate that this Slot is for Opponents that Did not participate.
|dnf=false
(Optional) Set to true to indicate that this Slot is for Opponents that Did not finish.
|dq=false
(Optional) Set to true to indicate that this Slot is for Opponents that were Disqualified.
|usdprize=
(Optional) USD Prize money associated with this placement.
|localprizeX=
(Optional) Matching a |localcurrencyX= from the header. |localprize1=4000 means opponents in this slot gets 4000€ as cash reward.
|percentage=
(Optional) Requires having |percentage= enabled in the header. |percentage=20 means opponents in this slot get 20% of the total prize pool as reward.
|pointsX=
(Optional) Matching a |pointsX= from the header. |points1=125 means opponents in this slot get 125 Dota Pro Circuit points.
|qualifiedX=
(Optional) Matching a |qualifiesX= from the header. |qualified1=yes means opponents in this slot are qualified to the Arlington Major.
|freetextX=
(Optional) Matching a |freetextX= from the header. |freetext1=NVIDIA RTX 3080 means opponents in this slot receive an NVIDIA RTX 3080.
|date=
(Optional)If opponents in this slot went out on a date different from the last day of the tournament, add it here. Formated as YYYY-MM-DD.
|X=
(Required) X is an ascending integer, starting at 1. See #Opponent for content. By mediawiki standards, can be ommited to just |.

Opponent

An opponent shall be contained with {{Opponent|}} template call. If the opponent is of another type than specified in the header, Opponent shall be replaced with the type the opponent is of, for instance {{SoloOpponent|}}. Parameters for the opponents should be seen on Template:SoloOpponent, Template:TeamOpponent. All prizes available in a slot can be overriden for a specific opponent if required.

|lastvs=
(Optional) (Heavily encouraged) The last opponent the team played against in that tournament. (Brackets only)
|lastvsscore=
(Optional) (Heavily encouraged) The score in the team's last match in that tournament. Formatted as teamScore-teamVsScore, |lastvsscore=1-3 (Brackets only)
|wdl=
(Optional) (Heavily encouraged) If the team went out of that tournament in a group stage, use this parameter with the values for W/D/L.
|date=
(Optional) If this opponent went out on a date different from the slot date and from the last day of the tournament, add it here. Formated as YYYY-MM-DD.


Example

{{TeamPrizePool|localcurrency1=eur|points1=points|points2=h-points|qualifies1=SomeLink|qualifies1name=Super Pro Tier
|{{Slot|localprize1=5000|points1=4711|qualified1=yes|{{Opponent|team liquid}}}}
|{{Slot|localprize1=2000|points1=1991|qualified1=yes|{{Opponent|team sweden}}}}
|{{Slot|localprize1=1000|points1=1337
 |{{Opponent|team germany|points2=17}}
 |{{Opponent|team netherlands|points2=7}}}}
}}
$TBA USD are spread among the participants as seen below:

Copy/paste

4 Teams, no bronze match

{{TeamPrizePool
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize=
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
}}
}}

4 Teams, bronze match

{{TeamPrizePool
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
}}

8 Teams, no bronze match

{{TeamPrizePool
|{{Slot |usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot |usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot |usdprize=
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
}}
|{{Slot|usdprize=
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
}}
}}

8 Teams, no bronze match, with local currency

{{TeamPrizePool|localcurrency=eur
|{{Slot |localprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot |localprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot |localprize=
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
}}
|{{Slot|localprize=
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
 |{{Opponent| |lastvs= |lastvsscore= |date=}}
}}
}}

16 Teams, USD Prize Pool

{{TeamPrizePool
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|usdprize=
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot|usdprize=
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot|usdprize=
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
}}

16 Teams, Foreign Currency Prize Pool

{{TeamPrizePool|localcurrency=
|{{Slot|localprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|localprize= |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot|localprize= 
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot|localprize= 
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot|localprize= 
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
}}

32 Team Open Qualifier Prize Pool

{{TeamPrizePool|qualifies1=<link to tournament>
|{{Slot |qualified=yes |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot |qualified=yes |{{Opponent| |lastvs= |lastvsscore= }}}}
|{{Slot |qualified=yes
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
|{{Slot
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
 |{{Opponent| |lastvs= |lastvsscore=}}
}}
}}
Retrieved from "https://liquipedia.net/commons/index.php?title=Template:SoloPrizePool&oldid=513367"