Commit: b16e174e1c9b8f26b6658673370d040c821bd103 - zandronum-cluster (hg)

This is a fork of Zandronum used on servers hosted by The Sentinels Playground (TSPG), Euroboros (EB), and Down Under Doomers (DUD).

Commit MetaInfo

• Révision: b16e174e1c9b8f26b6658673370d040c821bd103 (tree)
• l'heure: 2023-04-23 12:07:25
• Auteur: Adam Kaminski <kaminskiadam9@gmai...>
• Commiter: Adam Kaminski

Message de Log

Added the ScoreMargin class, and a base class for all margin SCORINFO commands.

Change Summary

• modified: gzdoom.vcproj
• modified: src/CMakeLists.txt
• modified: src/scoreboard.cpp
• modified: src/scoreboard.h
• modified: src/scoreboard_enums.h
• add: src/scoreboard_margin.cpp

Modification

diff -r 3622eb9e1a88 -r b16e174e1c9b gzdoom.vcproj
--- a/gzdoom.vcproj	Fri Apr 14 09:57:45 2023 -0400
+++ b/gzdoom.vcproj	Sat Apr 22 23:07:25 2023 -0400
@@ -1089,6 +1089,10 @@
 				>
 			</File>
 			<File
+				RelativePath=".\src\scoreboard_margin.cpp"
+				>
+			</File>
+			<File
 				RelativePath=".\src\sectinfo.cpp"
 				>
 			</File>

diff -r 3622eb9e1a88 -r b16e174e1c9b src/CMakeLists.txt
--- a/src/CMakeLists.txt	Fri Apr 14 09:57:45 2023 -0400
+++ b/src/CMakeLists.txt	Sat Apr 22 23:07:25 2023 -0400
@@ -1218,6 +1218,7 @@
 	s_sound.cpp
 	sc_man.cpp
 	scoreboard.cpp #ST
+	scoreboard_margin.cpp #ZA
 	sectinfo.cpp #ST
 	st_stuff.cpp
 	statistics.cpp

diff -r 3622eb9e1a88 -r b16e174e1c9b src/scoreboard.cpp
--- a/src/scoreboard.cpp	Fri Apr 14 09:57:45 2023 -0400
+++ b/src/scoreboard.cpp	Sat Apr 22 23:07:25 2023 -0400
@@ -2247,7 +2247,11 @@
 	ulGapBetweenColumns( 0 ),
 	ulGapBetweenRows( 0 ),
 	lHeaderHeight( 0 ),
-	lRowHeight( 0 ) { }
+	lRowHeight( 0 ),
+	MainHeader( MARGINTYPE_HEADER_OR_FOOTER, "MainHeader" ),
+	TeamHeader( MARGINTYPE_TEAM, "TeamHeader" ),
+	SpectatorHeader( MARGINTYPE_SPECTATOR, "SpectatorHeader" ),
+	Footer( MARGINTYPE_HEADER_OR_FOOTER, "Footer" ) { }
 
 //*****************************************************************************
 //
@@ -2772,7 +2776,7 @@
 	if ( ulWidth == 0 )
 		return;
 
-	UpdateHeight( );
+	UpdateHeight( ulDisplayPlayer );
 
 	// [AK] Reset the player list then sort players based on the scoreboard's rank order.
 	for ( ULONG ulIdx = 0; ulIdx < MAXPLAYERS; ulIdx++ )
@@ -2839,14 +2843,18 @@
 //
 //*****************************************************************************
 
-void Scoreboard::UpdateHeight( void )
+void Scoreboard::UpdateHeight( const ULONG ulDisplayPlayer )
 {
 	const ULONG ulRowYOffset = lRowHeight + ulGapBetweenRows;
 	const ULONG ulNumActivePlayers = HUD_GetNumPlayers( );
 	const ULONG ulNumSpectators = HUD_GetNumSpectators( );
+	const ULONG ulWidthWithoutBorder = ulWidth - 2 * ulBackgroundBorderSize;
 
 	ulHeight = 2 * ulBackgroundBorderSize + lHeaderHeight + ulGapBetweenHeaderAndRows;
 
+	MainHeader.Refresh( ulDisplayPlayer, ulWidthWithoutBorder );
+	ulHeight += MainHeader.GetHeight( );
+
 	if (( ulFlags & SCOREBOARDFLAG_DONTDRAWBORDERS ) == false )
 	{
 		// [AK] The borders are drawn in three places: above and below the column headers, and
@@ -2869,7 +2877,16 @@
 			const ULONG ulNumTeamsWithPlayers = TEAM_TeamsWithPlayersOn( );
 
 			if ( ulNumTeamsWithPlayers > 0 )
+			{
+				// [AK] Refresh and add the heights of all team headers too, if allowed.
+				if (( ulFlags & SCOREBOARDFLAG_DONTSHOWTEAMHEADERS ) == false )
+				{
+					TeamHeader.Refresh( ulDisplayPlayer, ulWidthWithoutBorder );
+					ulHeight += TeamHeader.GetHeight( ) * ulNumTeamsWithPlayers;
+				}
+
 				ulHeight += lRowHeight * ( ulNumTeamsWithPlayers - 1 );
+			}
 		}
 	}
 
@@ -2879,9 +2896,19 @@
 		if ( ulNumActivePlayers > 0 )
 			ulHeight += lRowHeight;
 
+		// [AK] Refresh and add the height of the spectator header too, if allowed.
+		if (( ulFlags & SCOREBOARDFLAG_DONTSHOWTEAMHEADERS ) == false )
+		{
+			SpectatorHeader.Refresh( ulDisplayPlayer, ulWidthWithoutBorder );
+			ulHeight += SpectatorHeader.GetHeight( );
+		}
+
 		ulHeight += ulNumSpectators * ulRowYOffset;
 	}
 
+	Footer.Refresh( ulDisplayPlayer, ulWidthWithoutBorder );
+	ulHeight += Footer.GetHeight( );
+
 	lRelY = ( HUD_GetHeight( ) - ulHeight ) / 2;
 }
 
@@ -2915,6 +2942,9 @@
 	LONG lYPos = lRelY + ulBackgroundBorderSize;
 	bool bUseLightBackground = true;
 
+	// [AK] Draw the main header first.
+	MainHeader.Render( ulDisplayPlayer, ScoreMargin::NO_TEAM, lYPos, fAlpha );
+
 	// [AK] Draw a border above the column headers.
 	DrawBorder( HeaderColor, lYPos, fAlpha, false );
 
@@ -2932,13 +2962,21 @@
 	for ( ULONG ulIdx = 0; ulIdx < ulNumActivePlayers; ulIdx++ )
 	{
 		const ULONG ulPlayer = ulPlayerList[ulIdx];
+		const ULONG ulTeam = players[ulPlayer].Team;
 
 		// [AK] In team-based game modes, if the previous player is on a different team than
 		// the current player, leave a gap between both teams and make the row background light.
-		if (( ShouldSeparateTeams( )) && ( ulIdx > 0 ) && ( players[ulPlayer].Team != players[ulPlayerList[ulIdx - 1]].Team ))
+		if (( ShouldSeparateTeams( )) && (( ulIdx == 0 ) || ( ulTeam != players[ulPlayerList[ulIdx - 1]].Team )))
 		{
-			lYPos += lRowHeight;
-			bUseLightBackground = true;
+			if ( ulIdx > 0 )
+			{
+				lYPos += lRowHeight;
+				bUseLightBackground = true;
+			}
+
+			// [AK] Draw the header for this team, if allowed.
+			if (( ulFlags & SCOREBOARDFLAG_DONTSHOWTEAMHEADERS ) == false )
+				TeamHeader.Render( ulDisplayPlayer, ulTeam, lYPos, fAlpha );
 		}
 
 		DrawRow( ulPlayer, ulDisplayPlayer, lYPos, fAlpha, bUseLightBackground );
@@ -2957,16 +2995,23 @@
 			bUseLightBackground = true;
 		}
 
+		// [AK] Draw the header for spectators, if allowed.
+		if (( ulFlags & SCOREBOARDFLAG_DONTSHOWTEAMHEADERS ) == false )
+			SpectatorHeader.Render( ulDisplayPlayer, ScoreMargin::NO_TEAM, lYPos, fAlpha );
+
 		// [AK] The index of the first true spectator should be the same as the number of active
 		// players. The list is organized such that all active players come before any true spectators.
 		for ( ULONG ulIdx = ulNumActivePlayers; ulIdx < ulTotalPlayers; ulIdx++ )
 			DrawRow( ulPlayerList[ulIdx], ulDisplayPlayer, lYPos, fAlpha, bUseLightBackground );
 	}
 
-	// [AK] Finally, draw a border at the bottom of the scoreboard. We must subtract ulGapBetweenRows here (a bit hacky)
+	// [AK] Draw a border at the bottom of the scoreboard. We must subtract ulGapBetweenRows here (a bit hacky)
 	// because SCOREBOARD_s::DrawPlayerRow adds it every time a row is drawn. This isn't necessary for the last row.
 	lYPos += ulGapBetweenHeaderAndRows - ulGapBetweenRows;
 	DrawBorder( HeaderColor, lYPos, fAlpha, false );
+
+	// [AK] Finally, draw the footer.
+	Footer.Render( ulDisplayPlayer, ScoreMargin::NO_TEAM, lYPos, fAlpha );
 }
 
 //*****************************************************************************

diff -r 3622eb9e1a88 -r b16e174e1c9b src/scoreboard.h
--- a/src/scoreboard.h	Fri Apr 14 09:57:45 2023 -0400
+++ b/src/scoreboard.h	Sat Apr 22 23:07:25 2023 -0400
@@ -88,6 +88,17 @@
 };
 
 //*****************************************************************************
+//
+// [AK] Margin types, either a header/footer, or a team or spectator header.
+//
+enum MARGINTYPE_e
+{
+	MARGINTYPE_HEADER_OR_FOOTER,
+	MARGINTYPE_TEAM,
+	MARGINTYPE_SPECTATOR,
+};
+
+//*****************************************************************************
 enum
 {
 	COLUMN_EMPTY,
@@ -402,6 +413,56 @@
 
 //*****************************************************************************
 //
+// [AK] ScoreMargin
+//
+// Draws the main header, footer, and all of the team/spectator headers using
+// a variety of commands that are parsed from the SCORINFO lumps.
+//
+//*****************************************************************************
+
+class ScoreMargin
+{
+public:
+	// [AK] A base class for all boundary commands in SCORINFO.
+	class BaseCommand
+	{
+	public:
+		BaseCommand( ScoreMargin *pMargin );
+
+		virtual void Parse( FScanner &sc ) = 0;
+		virtual void Refresh( const ULONG ulDisplayPlayer ) = 0;
+		virtual void Draw( const ULONG ulDisplayPlayer, const ULONG ulTeam, const LONG lYPos, const float fAlpha ) const = 0;
+
+	protected:
+		ScoreMargin *const pParentMargin;
+	};
+
+	ScoreMargin( MARGINTYPE_e MarginType, const char *pszName );
+	~ScoreMargin( void ) { ClearCommands( ); }
+
+	MARGINTYPE_e GetType( void ) const { return Type; }
+	const char *GetName( void ) const { return Name.GetChars( ); }
+	ULONG GetWidth( void ) const { return ulWidth; }
+	ULONG GetHeight( void ) const { return ulHeight; }
+	void IncreaseHeight( ULONG ulExtraHeight ) { ulHeight += ulExtraHeight; }
+	void Refresh( const ULONG ulDisplayPlayer, const ULONG ulNewWidth );
+	void Render( const ULONG ulDisplayPlayer, const ULONG ulTeam, LONG &lYPos, const float fAlpha ) const;
+
+	// [AK] Indicates that this margin is drawing for no team.
+	const static unsigned int NO_TEAM = UCHAR_MAX;
+
+private:
+	void ClearCommands( void );
+
+	TArray<BaseCommand *> Commands;
+	const MARGINTYPE_e Type;
+	const FName Name;
+	ULONG ulWidth;
+	ULONG ulHeight;
+};
+
+//*****************************************************************************
+//
 // [AK] Scoreboard
 //
 // Contains all properties and columns on the scoreboard. The scoreboard is
@@ -487,11 +548,15 @@
 	ULONG ulPlayerList[MAXPLAYERS];
 	TArray<ScoreColumn *> ColumnOrder;
 	TArray<DataScoreColumn *> RankOrder;
+	ScoreMargin MainHeader;
+	ScoreMargin TeamHeader;
+	ScoreMargin SpectatorHeader;
+	ScoreMargin Footer;
 
 	void AddColumnToList( FScanner &sc, const bool bAddToRankOrder );
 	void RemoveColumnFromList( FScanner &sc, const bool bRemoveFromRankOrder );
 	void UpdateWidth( void );
-	void UpdateHeight( void );
+	void UpdateHeight( const ULONG ulDisplayPlayer );
 	void DrawRow( const ULONG ulPlayer, const ULONG ulDisplayPlayer, LONG &lYPos, const float fAlpha, bool &bUseLightBackground ) const;
 };
 

diff -r 3622eb9e1a88 -r b16e174e1c9b src/scoreboard_enums.h
--- a/src/scoreboard_enums.h	Fri Apr 14 09:57:45 2023 -0400
+++ b/src/scoreboard_enums.h	Sat Apr 22 23:07:25 2023 -0400
@@ -230,6 +230,8 @@
 	ENUM_ELEMENT2( SCOREBOARDFLAG_DONTSEPARATETEAMS, 0x20 ),
 	// The local row background color is never used.
 	ENUM_ELEMENT2( SCOREBOARDFLAG_DONTUSELOCALROWBACKGROUNDCOLOR, 0x40 ),
+	// Prevents any of the team headers from being shown.
+	ENUM_ELEMENT2( SCOREBOARDFLAG_DONTSHOWTEAMHEADERS, 0x80 ),
 }
 END_ENUM( SCOREBOARDFLAG_e )
 

diff -r 3622eb9e1a88 -r b16e174e1c9b src/scoreboard_margin.cpp
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/scoreboard_margin.cpp	Sat Apr 22 23:07:25 2023 -0400
@@ -0,0 +1,159 @@
+//-----------------------------------------------------------------------------
+//
+// Zandronum Source
+// Copyright (C) 2021-2023 Adam Kaminski
+// Copyright (C) 2021-2023 Zandronum Development Team
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+//    this list of conditions and the following disclaimer.
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+//    this list of conditions and the following disclaimer in the documentation
+//    and/or other materials provided with the distribution.
+// 3. Neither the name of the Zandronum Development Team nor the names of its
+//    contributors may be used to endorse or promote products derived from this
+//    software without specific prior written permission.
+// 4. Redistributions in any form must be accompanied by information on how to
+//    obtain complete source code for the software and any accompanying
+//    software that uses the software. The source code must either be included
+//    in the distribution or be available for no more than the cost of
+//    distribution plus a nominal fee, and must be freely redistributable
+//    under reasonable conditions. For an executable file, complete source
+//    code means the source code for all modules it contains. It does not
+//    include source code for modules or files that typically accompany the
+//    major components of the operating system on which the executable file
+//    runs.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+//
+//
+// Filename: scoreboard_margin.cpp
+//
+// Description: Contains everything that controls the scoreboard's margins
+// (i.e. the main header, team/spectator headers, and the footer).
+//
+//-----------------------------------------------------------------------------
+
+#include "scoreboard.h"
+
+//*****************************************************************************
+//	FUNCTIONS
+
+//*****************************************************************************
+//
+// [AK] ScoreMargin::BaseCommand::BaseCommand
+//
+// Initializes a margin command.
+//
+//*****************************************************************************
+
+ScoreMargin::BaseCommand::BaseCommand( ScoreMargin *pMargin ) : pParentMargin( pMargin )
+{
+	// [AK] This should never happen, but throw a fatal error if it does.
+	if ( pParentMargin == NULL )
+		I_Error( "ScoreMargin::BaseCommand: parent margin is NULL." );
+}
+
+//*****************************************************************************
+//
+// [AK] ScoreMargin::ScoreMargin
+//
+// Initializes a margin's members to their default values.
+//
+//*****************************************************************************
+
+ScoreMargin::ScoreMargin( MARGINTYPE_e MarginType, const char *pszName ) :
+	Type( MarginType ),
+	Name( pszName ),
+	ulWidth( 0 ),
+	ulHeight( 0 ) { }
+
+//*****************************************************************************
+//
+// [AK] ScoreMargin::Refresh
+//
+// Updates the margin's width and height, then refreshes its command list.
+//
+//*****************************************************************************
+
+void ScoreMargin::Refresh( const ULONG ulDisplayPlayer, const ULONG ulNewWidth )
+{
+	// [AK] If there's no commands, then don't do anything.
+	if ( Commands.Size( ) == 0 )
+		return;
+
+	// [AK] Never accept a width of zero, throw a fatal error if this happens.
+	if ( ulNewWidth == 0 )
+		I_Error( "ScoreMargin::Refresh: tried assigning a width of zero to '%s'.", GetName( ));
+
+	ulWidth = ulNewWidth;
+	ulHeight = 0;
+
+	for ( unsigned int i = 0; i < Commands.Size( ); i++ )
+		Commands[i]->Refresh( ulDisplayPlayer );
+}
+
+//*****************************************************************************
+//
+// [AK] ScoreMargin::Render
+//
+// Draws all commands that are defined inside the margin.
+//
+//*****************************************************************************
+
+void ScoreMargin::Render( const ULONG ulDisplayPlayer, const ULONG ulTeam, LONG &lYPos, const float fAlpha ) const
+{
+	// [AK] If this is supposed to be a team header, then we can't draw for invalid teams!
+	if ( Type == MARGINTYPE_TEAM )
+	{
+		if (( ulTeam == NO_TEAM ) || ( ulTeam >= teams.Size( )))
+			I_Error( "ScoreMargin::Render: '%s' can't be drawn for invalid teams.", GetName( ));
+	}
+	// [AK] Otherwise, if this is a non-team header, then we can't draw for any specific team!
+	else if ( ulTeam != NO_TEAM )
+	{
+		I_Error( "ScoreMargin::Render: '%s' must not be drawn for any specific team.", GetName( ));
+	}
+
+	// [AK] If there's no commands, or the width or height are zero, then we can't draw anything.
+	if (( Commands.Size( ) == 0 ) || ( ulWidth == 0 ) || ( ulHeight == 0 ))
+		return;
+
+	for ( unsigned int i = 0; i < Commands.Size( ); i++ )
+		Commands[i]->Draw( ulDisplayPlayer, ulTeam, lYPos, fAlpha );
+
+	lYPos += ulHeight;
+}
+
+//*****************************************************************************
+//
+// [AK] ScoreMargin::ClearCommands
+//
+// Deletes all of the margin's commands from memory.
+//
+//*****************************************************************************
+
+void ScoreMargin::ClearCommands( void )
+{
+	for ( unsigned int i = 0; i < Commands.Size( ); i++ )
+	{
+		delete Commands[i];
+		Commands[i] = NULL;
+	}
+
+	Commands.Clear( );
+}