Add note support to (party) block opponents

components/opponent/commons/opponent_display.lua

@@ -189,6 +189,8 @@ OpponentDisplay.propTypes.BlockOpponent = {
 ---@field abbreviateTbd boolean?
 ---@field playerClass string?
 ---@field teamStyle teamStyle?
+---@field dq boolean?
+---@field note string|number|nil
 
 --[[
 Displays an opponent as a block element. The width of the component is
@@ -228,9 +230,15 @@ end
 function OpponentDisplay.BlockPlayers(props)
 	local opponent = props.opponent
 
-	local playerNodes = Array.map(opponent.players, function(player)
-		return PlayerDisplay.BlockPlayer(Table.merge(props, {player = player, team = player.team}))
-			:addClass(props.playerClass)
+	--only apply note to first player, hence extract it here
+	local note = Table.extract(props, 'note')
+
+	local playerNodes = Array.map(opponent.players, function(player, playerIndex)
+		return PlayerDisplay.BlockPlayer(Table.merge(props, {
+			player = player,
+			team = player.team,
+			note = playerIndex == 1 and note or nil,
+		})):addClass(props.playerClass)
 	end)
 
 	local playersNode = mw.html.create('div')

components/opponent/commons/player_display.lua

@@ -33,6 +33,7 @@ PlayerDisplay.propTypes.BlockPlayer = {
 	showLink = 'boolean?',
 	showPlayerTeam = 'boolean?',
 	abbreviateTbd = 'boolean?',
+	note = 'string?',
 }
 
 --[[
@@ -64,11 +65,15 @@ function PlayerDisplay.BlockPlayer(props)
 			:node(mw.ext.TeamTemplate.teampart(player.team))
 	end
 
+	local noteNode = props.note and mw.html.create('span'):addClass('note'):wikitext(props.note) or nil
+
 	return mw.html.create('div'):addClass('block-player')
 		:addClass(props.flip and 'flipped' or nil)
 		:addClass(props.showPlayerTeam and 'has-team' or nil)
 		:node(flagNode)
+		:node(props.flip and noteNode or nil)
 		:node(nameNode)
+		:node(not props.flip and noteNode or nil)
 		:node(teamNode)
 end
 

components/opponent/commons/starcraft_starcraft2/opponent_display_starcraft.lua

@@ -178,19 +178,16 @@ function StarcraftOpponentDisplay.PlayerBlockOpponent(props)
 	local opponent = props.opponent
 	local showRace = props.showRace ~= false
 
-	local playerNodes = Array.map(opponent.players, function(player)
-		return StarcraftPlayerDisplay.BlockPlayer({
-			flip = props.flip,
-			overflow = props.overflow,
+	--only apply note to first player, hence extract it here
+	local note = Table.extract(props, 'note')
+
+	local playerNodes = Array.map(opponent.players, function(player, playerIndex)
+		return StarcraftPlayerDisplay.BlockPlayer(Table.merge(props, {
 			player = player,
-			showFlag = props.showFlag,
-			showLink = props.showLink,
-			showPlayerTeam = props.showPlayerTeam,
-			showRace = showRace and not opponent.isArchon and not opponent.isSpecialArchon,
 			team = player.team,
-			abbreviateTbd = props.abbreviateTbd,
-		})
-			:addClass(props.playerClass)
+			note = playerIndex == 1 and note or nil,
+			showRace = showRace and not opponent.isArchon and not opponent.isSpecialArchon,
+		})):addClass(props.playerClass)
 	end)
 
 	if #opponent.players == 1 then

components/opponent/commons/starcraft_starcraft2/player_display_starcraft.lua

@@ -39,6 +39,7 @@ StarcraftPlayerDisplay.propTypes.BlockPlayer = {
 	showPlayerTeam = 'boolean?',
 	showRace = 'boolean?',
 	abbreviateTbd = 'boolean?',
+	note = 'string?',
 }
 
 --[[
@@ -77,12 +78,16 @@ function StarcraftPlayerDisplay.BlockPlayer(props)
 			:node(mw.ext.TeamTemplate.teampart(player.team))
 	end
 
+	local noteNode = props.note and mw.html.create('span'):addClass('note'):wikitext(props.note) or nil
+
 	return html.create('div'):addClass('block-player starcraft-block-player')
 		:addClass(props.flip and 'flipped' or nil)
 		:addClass(props.showPlayerTeam and 'has-team' or nil)
 		:node(flagNode)
 		:node(raceNode)
+		:node(props.flip and noteNode or nil)
 		:node(nameNode)
+		:node(not props.flip and noteNode or nil)
 		:node(teamNode)
 end
 

components/opponent/wikis/fortnite/opponent_display_custom.lua

@@ -102,18 +102,15 @@ end
 function FortniteOpponentDisplay.PlayerBlockOpponent(props)
 	local opponent = props.opponent
 
-	local playerNodes = Array.map(opponent.players, function(player)
-		return PlayerDisplay.BlockPlayer({
-			flip = props.flip,
-			overflow = props.overflow,
+	--only apply note to first player, hence extract it here
+	local note = Table.extract(props, 'note')
+
+	local playerNodes = Array.map(opponent.players, function(player, playerIndex)
+		return PlayerDisplay.BlockPlayer(Table.merge(props, {
 			player = player,
-			showFlag = props.showFlag,
-			showLink = props.showLink,
-			showPlayerTeam = props.showPlayerTeam,
 			team = player.team,
-			abbreviateTbd = props.abbreviateTbd,
-		})
-			:addClass(props.playerClass)
+			note = playerIndex == 1 and note or nil,
+		})):addClass(props.playerClass)
 	end)
 
 	if #opponent.players == 1 then

components/opponent/wikis/warcraft/opponent_display_custom.lua

@@ -95,9 +95,16 @@ function CustomOpponentDisplay.BlockPlayers(props)
 	local opponent = props.opponent
 	local showRace = props.showRace ~= false
 
-	local playerNodes = Array.map(opponent.players, function(player)
-		return PlayerDisplay.BlockPlayer(Table.merge(props, {team = player.team, player = player, showRace = showRace}))
-			:addClass(props.playerClass)
+	--only apply note to first player, hence extract it here
+	local note = Table.extract(props, 'note')
+
+	local playerNodes = Array.map(opponent.players, function(player, playerIndex)
+		return PlayerDisplay.BlockPlayer(Table.merge(props, {
+			team = player.team,
+			player = player,
+			showRace = showRace,
+			note = playerIndex == 1 and note or nil,
+		})):addClass(props.playerClass)
 	end)
 
 	local playersNode = mw.html.create('div')

components/opponent/wikis/warcraft/player_display_custom.lua

@@ -33,6 +33,7 @@ CustomPlayerDisplay.propTypes.BlockPlayer = {
 	showPlayerTeam = 'boolean?',
 	showRace = 'boolean?',
 	abbreviateTbd = 'boolean?',
+	note = 'string?',
 }
 
 function CustomPlayerDisplay.BlockPlayer(props)
@@ -66,12 +67,16 @@ function CustomPlayerDisplay.BlockPlayer(props)
 			:node(mw.ext.TeamTemplate.teampart(player.team))
 	end
 
+	local noteNode = props.note and mw.html.create('span'):addClass('note'):wikitext(props.note) or nil
+
 	return mw.html.create('div'):addClass('block-player starcraft-block-player')
 		:addClass(props.flip and 'flipped' or nil)
 		:addClass(props.showPlayerTeam and 'has-team' or nil)
 		:node(flagNode)
 		:node(raceNode)
+		:node(props.flip and noteNode or nil)
 		:node(nameNode)
+		:node(not props.flip and noteNode or nil)
 		:node(teamNode)
 end