Module:ResultsTable

Module documentation[view] [edit] [history] [purge]

Builds Results/Achievements Table.

Is customizable on a per wiki basis via Module:ResultsTable/Custom

Parameters

Query Conditions

|game=

Limit the query to only fetch results with the given game

|startdate=|sdate=

Limit the query to only fetch results that were achieved >= the start date

|enddate=|edate=

Limit the query to only fetch results that were achieved <= the end date

|placement=

Limit the query to only fetch results with the given placement

|tier=

Limit the query to only fetch results with the given liquipedia tier

You can enter several tiers sep. by ,. Example: |tier=1,2

|order=

Order in which the lpdb query should sort

default: desc

|sort=

Sort column after which the lpdb query should sort

for achievements the default is weight, for results the default is date

|playerResultsOfTeam=

If set to true this will make the query for team opponents also look for non team results of players that were on the team while they achieved the placement

|additionalConditions=

Field with which additional conditions can be added via Module:ResultsTable/Custom

|customConditions=

Field with which conditions can be completely overwritten via Module:ResultsTable/Custom

|playerLimit= |coachLimit=

amount of players the query has to be expect when querying player/coach results

use the according param for the according query type

General Settings

|querytype= MANDATORY!!!

Type of the participant for which to query

Valid entries are: solo, team, coach

|hideresult=

Do not display the lastVs/Score column

|gameIcons=

Displays and additional game icons column

|achievements=

Set to true to query achievements instead of results

limits amount of returned rows (unles limit is overwritten); sorts by weight during the query

Input

|data=

Manually provided data passed in form of a lua table in the format the query would return

Intended to be only used via Module:ResultsTable/Custom

Circumvents the lpdb query of Module:ResultsTable/Base

|manualContent=

Manual Input that gets added at the bottom of the results/achievements table

Intended to be used via Module:ResultsTable/Custom, for an example see starcraft2:Module:ResultsTable/Custom

|coach=|player=|team=

The coach/player/team for which to query data

In main space this defaults to the BASEPAGENAME

In other namespaces if the FULLPAGENAME contains "results" it defaults to TitleParts[#TitleParts - 1]

In other namespaces if the FULLPAGENAME does not contain "results" it defaults to SUBPAGENAME

---

---
-- @Liquipedia
-- wiki=commons
-- page=Module:ResultsTable
--
-- Please see https://github.com/Liquipedia/Lua-Modules to contribute
--

local Abbreviation = require('Module:Abbreviation')
local Class = require('Module:Class')
local Currency = require('Module:Currency')
local Game = require('Module:Game')
local LeagueIcon = require('Module:LeagueIcon')
local Lua = require('Module:Lua')
local Page = require('Module:Page')
local Placement = require('Module:Placement')
local Table = require('Module:Table')

local BaseResultsTable = Lua.import('Module:ResultsTable/Base')

local OpponentLibrary = require('Module:OpponentLibraries')
local Opponent = OpponentLibrary.Opponent

--- @class ResultsTable: BaseResultsTable
local ResultsTable = Class.new(BaseResultsTable)

---Builds the Header of the results/achievements table
---@return Html
function ResultsTable:buildHeader()
	local header = mw.html.create('tr')
		:tag('th'):css('width', '100px'):wikitext('Date'):done()
		:tag('th'):css('min-width', '80px'):wikitext('Place'):done()
		:tag('th'):css('min-width', '75px'):wikitext('Tier'):done()

	if self.config.showType then
		header:tag('th'):css('min-width', '50px'):wikitext('Type')
	end

	if self.config.displayGameIcons then
		header:tag('th'):node(Abbreviation.make('G.', 'Game'))
	end

	header:tag('th'):css('width', '420px'):attr('colspan', 2):wikitext('Tournament')

	if self.config.queryType ~= Opponent.team or Table.isNotEmpty(self.config.aliases) then
		header:tag('th'):css('min-width', '70px'):wikitext('Team')
	elseif self.config.playerResultsOfTeam then
		header:tag('th'):css('min-width', '105px'):wikitext('Player')
	end

	if not self.config.hideResult then
		header:tag('th'):css('min-width', '105px'):attr('colspan', 2):addClass('unsortable'):wikitext('Result')
	end

	header:tag('th'):attr('data-sort-type', 'currency'):wikitext('Prize')

	return header
end

---Builds a placement row of the results/achievements table
---@param placement table
---@return Html
function ResultsTable:buildRow(placement)
	local placementCell = mw.html.create('td')
	Placement._placement{parent = placementCell, placement = placement.placement}

	local row = mw.html.create('tr')
		:addClass(self:rowHighlight(placement))
		:tag('td'):wikitext(mw.getContentLanguage():formatDate('Y-m-d', placement.date)):done()
		:node(placementCell)

	local tierDisplay, tierSortValue = self:tierDisplay(placement)

	row:tag('td'):attr('data-sort-value', tierSortValue):wikitext(tierDisplay)

	if self.config.showType then
		row:tag('td'):wikitext(placement.type)
	end

	if self.config.displayGameIcons then
		row:tag('td'):node(Game.icon{game = placement.game})
	end

	local tournamentDisplayName = BaseResultsTable.tournamentDisplayName(placement)

	row
		:tag('td'):css('width', '30px'):attr('data-sort-value', tournamentDisplayName):wikitext(LeagueIcon.display{
			icon = placement.icon,
			iconDark = placement.icondark,
			link = placement.parent,
			name = tournamentDisplayName,
			options = {noTemplate = true},
		}):done()
		:tag('td'):attr('data-sort-value', tournamentDisplayName):css('text-align', 'left'):wikitext(Page.makeInternalLink(
			{},
			tournamentDisplayName,
			placement.pagename
		))

	if self.config.playerResultsOfTeam or
		self.config.queryType ~= Opponent.team or
		Table.isNotEmpty(self.config.aliases) then

		row:tag('td'):css('text-align', self.config.hideResult and 'left' or 'right')
			:attr('data-sort-value', placement.opponentname)
			:node(self:opponentDisplay(placement,
			{teamForSolo = not self.config.playerResultsOfTeam, flip = not self.config.hideResult}
		))
	end

	if not self.config.hideResult then
		local score, vsDisplay, groupAbbr = self:processVsData(placement)
		row
			:tag('td'):wikitext(score):done()
			:tag('td'):css('text-align', 'left'):cssText(groupAbbr and 'padding-left:14px' or nil):node(vsDisplay or groupAbbr)
	end

	local useIndivPrize = self.config.useIndivPrize and self.config.queryType ~= Opponent.team
	row:tag('td'):wikitext(Currency.display('USD',
			useIndivPrize and placement.individualprizemoney or placement.prizemoney,
			{dashIfZero = true, displayCurrencyCode = false, formatValue = true}
		))

	return row
end

return ResultsTable