Rework partial GameModeMap and GameLobby codes

ClientCore/Extensions/IniFileExtensions.cs

@@ -1,6 +1,8 @@
-using System.Collections.Generic;
+#nullable enable
+
+using System;
+using System.Collections.Generic;
 using System.Linq;
-using System.Runtime.CompilerServices;
 
 using Rampastring.Tools;
 
@@ -26,7 +28,7 @@ public static void RemoveAllKeys(this IniSection iniSection)
                 iniSection.RemoveKey(iniSectionKey.Key);
         }
 
-        public static string[] GetStringListValue(this IniFile iniFile, string section, string key, string defaultValue, char[] separators = null)
+        public static string[] GetStringListValue(this IniFile iniFile, string section, string key, string defaultValue, char[]? separators = null)
         {
             separators ??= [','];
             IniSection iniSection = iniFile.GetSection(section);
@@ -38,5 +40,18 @@ public static string[] GetStringListValue(this IniFile iniFile, string section,
                 .Where(s => !string.IsNullOrEmpty(s))
                 .ToArray();
         }
+
+        public static string? GetStringValueOrNull(this IniSection section, string key) =>
+            section.KeyExists(key) ? section.GetStringValue(key, string.Empty) : null;
+
+        public static int? GetIntValueOrNull(this IniSection section, string key) =>
+            section.KeyExists(key) ? section.GetIntValue(key, 0) : null;
+
+        public static bool? GetBooleanValueOrNull(this IniSection section, string key) =>
+            section.KeyExists(key) ? section.GetBooleanValue(key, false) : null;
+
+        public static List<T>? GetListValueOrNull<T>(this IniSection section, string key, char separator, Func<string, T> converter) =>
+            section.KeyExists(key) ? section.GetListValue<T>(key, separator, converter) : null;
+
     }
 }

DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs

@@ -791,16 +791,16 @@ private void HandleOptionsRequest(string playerName, int options)
             if (0 < side && side < SideCount && disallowedSides[side])
                 return;
 
-            if (Map?.CoopInfo != null)
+            if (GameModeMap?.CoopInfo != null)
             {
-                if (Map.CoopInfo.DisallowedPlayerSides.Contains(side - 1) || side == SideCount + RandomSelectorCount)
+                if (GameModeMap.CoopInfo.DisallowedPlayerSides.Contains(side - 1) || side == SideCount + RandomSelectorCount)
                     return;
 
-                if (Map.CoopInfo.DisallowedPlayerColors.Contains(color - 1))
+                if (GameModeMap.CoopInfo.DisallowedPlayerColors.Contains(color - 1))
                     return;
             }
 
-            if (start < 0 || start > Map?.MaxPlayers)
+            if (!(start == 0 || (GameModeMap?.AllowedStartingLocations?.Contains(start) ?? true)))
                 return;
 
             if (team < 0 || team > 4)

DXMainClient/DXGUI/Multiplayer/GameLobby/LANGameLobby.cs

@@ -845,16 +845,16 @@ private void HandlePlayerOptionsRequest(string sender, string data)
             if (side > 0 && side <= SideCount && disallowedSides[side - 1])
                 return;
 
-            if (Map.CoopInfo != null)
+            if (GameModeMap.CoopInfo != null)
             {
-                if (Map.CoopInfo.DisallowedPlayerSides.Contains(side - 1) || side == SideCount + RandomSelectorCount)
+                if (GameModeMap.CoopInfo.DisallowedPlayerSides.Contains(side - 1) || side == SideCount + RandomSelectorCount)
                     return;
 
-                if (Map.CoopInfo.DisallowedPlayerColors.Contains(color - 1))
+                if (GameModeMap.CoopInfo.DisallowedPlayerColors.Contains(color - 1))
                     return;
             }
 
-            if (start < 0 || start > Map.MaxPlayers)
+            if (!(start == 0 || (GameModeMap?.AllowedStartingLocations?.Contains(start) ?? true)))
                 return;
 
             if (team < 0 || team > 4)

DXMainClient/DXGUI/Multiplayer/GameLobby/MapPreviewBox.cs

@@ -260,7 +260,7 @@ private void ContextMenu_OptionSelected(int index)
         {
             SoundPlayer.Play(sndDropdownSound);
 
-            if (GameModeMap.Map.EnforceMaxPlayers)
+            if (GameModeMap.EnforceMaxPlayers)
             {
                 foreach (PlayerInfo pInfo in players.Concat(aiPlayers))
                 {
@@ -301,7 +301,7 @@ private void Indicator_LeftClick(object sender, EventArgs e)
 
             if (!EnableContextMenu)
             {
-                if (GameModeMap.Map.EnforceMaxPlayers)
+                if (GameModeMap.EnforceMaxPlayers)
                 {
                     foreach (PlayerInfo pInfo in players.Concat(aiPlayers))
                     {
@@ -455,22 +455,25 @@ private void UpdateMap()
 
             List<Point> startingLocations = GameModeMap.Map.GetStartingLocationPreviewCoords(new Point(previewTexture.Width, previewTexture.Height));
 
-            for (int i = 0; i < startingLocations.Count && i < GameModeMap.Map.MaxPlayers; i++)
+            for (int i = 0; i < MAX_STARTING_LOCATIONS; i++)
             {
-                PlayerLocationIndicator indicator = startingLocationIndicators[i];
+                bool showLocation = i < startingLocations.Count && GameModeMap.AllowedStartingLocations.Contains(i + 1);
+                if (showLocation)
+                {
+                    PlayerLocationIndicator indicator = startingLocationIndicators[i];
 
-                Point location = new Point(
-                    texturePositionX + (int)(startingLocations[i].X * ratio),
-                    texturePositionY + (int)(startingLocations[i].Y * ratio));
+                    Point location = new Point(
+                        texturePositionX + (int)(startingLocations[i].X * ratio),
+                        texturePositionY + (int)(startingLocations[i].Y * ratio));
 
-                indicator.SetPosition(location);
-                indicator.Enabled = true;
-                indicator.Visible = true;
-            }
-
-            for (int i = startingLocations.Count; i < MAX_STARTING_LOCATIONS; i++)
-            {
-                startingLocationIndicators[i].Disable();
+                    indicator.SetPosition(location);
+                    indicator.Enabled = true;
+                    indicator.Visible = true;
+                }
+                else
+                {
+                    startingLocationIndicators[i].Disable();
+                }
             }
 
 

DXMainClient/DXGUI/Multiplayer/GameLobby/MultiplayerGameLobby.cs

@@ -16,6 +16,7 @@
 using Microsoft.Xna.Framework.Graphics;
 using ClientCore.Extensions;
 using DTAClient.DXGUI.Multiplayer.CnCNet;
+using System.Diagnostics;
 
 namespace DTAClient.DXGUI.Multiplayer.GameLobby
 {
@@ -801,7 +802,7 @@ protected override void BtnLaunchGame_LeftClick(object sender, EventArgs e)
                 return;
             }
 
-            if (Map.EnforceMaxPlayers)
+            if (GameModeMap.EnforceMaxPlayers)
             {
                 foreach (PlayerInfo pInfo in Players)
                 {
@@ -836,14 +837,14 @@ protected override void BtnLaunchGame_LeftClick(object sender, EventArgs e)
                 int totalPlayerCount = Players.Count(p => p.SideId < ddPlayerSides[0].Items.Count - 1)
                     + AIPlayers.Count;
 
-                int minPlayers = GameMode.MinPlayersOverride > -1 ? GameMode.MinPlayersOverride : Map.MinPlayers;
+                int minPlayers = GameModeMap.MinPlayers;
                 if (totalPlayerCount < minPlayers)
                 {
                     InsufficientPlayersNotification();
                     return;
                 }
 
-                if (Map.EnforceMaxPlayers && totalPlayerCount > Map.MaxPlayers)
+                if (GameModeMap.EnforceMaxPlayers && totalPlayerCount > GameModeMap.MaxPlayers)
                 {
                     TooManyPlayersNotification();
                     return;
@@ -895,7 +896,7 @@ protected override void BtnLaunchGame_LeftClick(object sender, EventArgs e)
                     GetReadyNotification();
                     return;
                 }
-                
+
             }
 
             HostLaunchGame();
@@ -937,19 +938,16 @@ protected virtual void GetReadyNotification()
 
         protected virtual void InsufficientPlayersNotification()
         {
-            if (GameMode != null && GameMode.MinPlayersOverride > -1)
-                AddNotice(String.Format("Unable to launch game: {0} cannot be played with fewer than {1} players".L10N("Client:Main:InsufficientPlayersNotification1"),
-                    GameMode.UIName, GameMode.MinPlayersOverride));
-            else if (Map != null)
-                AddNotice(String.Format("Unable to launch game: this map cannot be played with fewer than {0} players.".L10N("Client:Main:InsufficientPlayersNotification2"),
-                    Map.MinPlayers));
+            Debug.Assert(GameModeMap != null, "GameModeMap should not be null");
+            AddNotice(string.Format("Unable to launch game: {0} cannot be played with fewer than {1} players".L10N("Client:Main:InsufficientPlayersNotification1"),
+                GameModeMap.ToString(), GameModeMap.MinPlayers));
         }
 
         protected virtual void TooManyPlayersNotification()
         {
-            if (Map != null)
-                AddNotice(String.Format("Unable to launch game: this map cannot be played with more than {0} players.".L10N("Client:Main:TooManyPlayersNotification"),
-                    Map.MaxPlayers));
+            Debug.Assert(GameModeMap != null, "GameModeMap should not be null");
+            AddNotice(string.Format("Unable to launch game: {0} cannot be played with more than {1} players.".L10N("Client:Main:TooManyPlayersNotification1"),
+                GameModeMap.ToString(), GameModeMap.MaxPlayers));
         }
 
         public virtual void Clear()
@@ -1017,7 +1015,8 @@ protected override void CopyPlayerDataToUI()
                 {
                     StatusIndicators[pId].SwitchTexture("error");
                 }
-                else */ if (Players[pId].IsInGame) // If player is ingame
+                else */
+                if (Players[pId].IsInGame) // If player is ingame
                 {
                     StatusIndicators[pId].SwitchTexture(PlayerSlotState.InGame);
                 }
@@ -1152,10 +1151,10 @@ protected override void WriteSpawnIniAdditions(IniFile iniFile)
 
         protected override int GetDefaultMapRankIndex(GameModeMap gameModeMap)
         {
-            if (gameModeMap.Map.MaxPlayers > 3)
-                return StatisticsManager.Instance.GetCoopRankForDefaultMap(gameModeMap.Map.UntranslatedName, gameModeMap.Map.MaxPlayers);
+            if (gameModeMap.MaxPlayers > 3)
+                return StatisticsManager.Instance.GetCoopRankForDefaultMap(gameModeMap.Map.UntranslatedName, gameModeMap.MaxPlayers);
 
-            if (StatisticsManager.Instance.HasWonMapInPvP(gameModeMap.Map.UntranslatedName, gameModeMap.GameMode.UntranslatedUIName, gameModeMap.Map.MaxPlayers))
+            if (StatisticsManager.Instance.HasWonMapInPvP(gameModeMap.Map.UntranslatedName, gameModeMap.GameMode.UntranslatedUIName, gameModeMap.MaxPlayers))
                 return 2;
 
             return -1;
@@ -1171,7 +1170,7 @@ protected override void UpdateMapPreviewBoxEnabledStatus()
         {
             if (Map != null && GameMode != null)
             {
-                bool disablestartlocs = (Map.ForceRandomStartLocations || GameMode.ForceRandomStartLocations || GetPlayerExtraOptions().IsForceRandomStarts);
+                bool disablestartlocs = GameModeMap.ForceRandomStartLocations || GetPlayerExtraOptions().IsForceRandomStarts;
                 MapPreviewBox.EnableContextMenu = disablestartlocs ? false : IsHost;
                 MapPreviewBox.EnableStartLocationSelection = !disablestartlocs;
             }

DXMainClient/DXGUI/Multiplayer/GameLobby/SkirmishLobby.cs

@@ -109,35 +109,24 @@ private string CheckGameValidity()
             int totalPlayerCount = Players.Count(p => p.SideId < ddPlayerSides[0].Items.Count - 1)
                 + AIPlayers.Count;
 
-            if (GameMode.MultiplayerOnly)
+            if (GameModeMap.MultiplayerOnly)
             {
-                return String.Format("{0} can only be played on CnCNet and LAN.".L10N("Client:Main:GameModeMultiplayerOnly"),
-                    GameMode.UIName);
+                return string.Format("{0} can only be played on CnCNet and LAN.".L10N("Client:Main:GameModeMultiplayerOnly"),
+                    GameModeMap.ToString());
             }
 
-            if (GameMode.MinPlayersOverride > -1 && totalPlayerCount < GameMode.MinPlayersOverride)
+            if (totalPlayerCount < GameModeMap.MinPlayers)
             {
-                return String.Format("{0} cannot be played with less than {1} players.".L10N("Client:Main:GameModeInsufficientPlayers"),
-                         GameMode.UIName, GameMode.MinPlayersOverride);
+                return string.Format("{0} cannot be played with less than {1} players.".L10N("Client:Main:GameModeInsufficientPlayers"),
+                         GameModeMap.ToString(), GameModeMap.MinPlayers);
             }
 
-            if (Map.MultiplayerOnly)
+            if (GameModeMap.EnforceMaxPlayers)
             {
-                return "The selected map can only be played on CnCNet and LAN.".L10N("Client:Main:MapMultiplayerOnly");
-            }
-
-            if (totalPlayerCount < Map.MinPlayers)
-            {
-                return String.Format("The selected map cannot be played with less than {0} players.".L10N("Client:Main:MapInsufficientPlayers"),
-                    Map.MinPlayers);
-            }
-
-            if (Map.EnforceMaxPlayers)
-            {
-                if (totalPlayerCount > Map.MaxPlayers)
+                if (totalPlayerCount > GameModeMap.MaxPlayers)
                 {
-                    return String.Format("The selected map cannot be played with more than {0} players.".L10N("Client:Main:MapTooManyPlayers"),
-                        Map.MaxPlayers);
+                    return string.Format("{0} cannot be played with more than {1} players.".L10N("Client:Main:TooManyPlayers"),
+                        GameModeMap.ToString(), GameModeMap.MaxPlayers);
                 }
 
                 IEnumerable<PlayerInfo> concatList = Players.Concat(AIPlayers);
@@ -154,7 +143,7 @@ private string CheckGameValidity()
                 }
             }
 
-            if (Map.IsCoop && Players[0].SideId == ddPlayerSides[0].Items.Count - 1)
+            if (GameModeMap.IsCoop && Players[0].SideId == ddPlayerSides[0].Items.Count - 1)
             {
                 return "Co-op missions cannot be spectated. You'll have to show a bit more effort to cheat here.".L10N("Client:Main:CoOpMissionSpectatorPrompt");
             }
@@ -223,7 +212,7 @@ protected override bool AllowPlayerOptionsChange()
 
         protected override int GetDefaultMapRankIndex(GameModeMap gameModeMap)
         {
-            return StatisticsManager.Instance.GetSkirmishRankForDefaultMap(gameModeMap.Map.UntranslatedName, gameModeMap.Map.MaxPlayers);
+            return StatisticsManager.Instance.GetSkirmishRankForDefaultMap(gameModeMap.Map.UntranslatedName, gameModeMap.MaxPlayers);
         }
 
         protected override void GameProcessExited()
@@ -369,7 +358,7 @@ private void LoadSettings()
                 //return;
             }
 
-            bool AIAllowed = !(Map.HumanPlayersOnly || GameMode.HumanPlayersOnly);
+            bool AIAllowed = !GameModeMap.HumanPlayersOnly;
             foreach (string key in keys)
             {
                 if (!AIAllowed) break;
@@ -469,13 +458,13 @@ private void CheckLoadedPlayerVariableBounds(PlayerInfo pInfo, bool isAIPlayer =
             }
 
             if (pInfo.TeamId < 0 || pInfo.TeamId >= ddPlayerTeams[0].Items.Count ||
-                !Map.IsCoop && (Map.ForceNoTeams || GameMode.ForceNoTeams))
+                !GameModeMap.IsCoop && GameModeMap.ForceNoTeams)
             {
                 pInfo.TeamId = 0;
             }
 
             if (pInfo.StartingLocation < 0 || pInfo.StartingLocation > MAX_PLAYER_COUNT ||
-                !Map.IsCoop && (Map.ForceRandomStartLocations || GameMode.ForceRandomStartLocations))
+                GameModeMap.ForceRandomStartLocations)
             {
                 pInfo.StartingLocation = 0;
             }
@@ -497,7 +486,7 @@ private void InitDefaultSettings()
 
         protected override void UpdateMapPreviewBoxEnabledStatus()
         {
-            MapPreviewBox.EnableContextMenu = !((Map != null && Map.ForceRandomStartLocations) || (GameMode != null && GameMode.ForceRandomStartLocations) || GetPlayerExtraOptions().IsForceRandomStarts);
+            MapPreviewBox.EnableContextMenu = !(GameModeMap.ForceRandomStartLocations || GetPlayerExtraOptions().IsForceRandomStarts);
             MapPreviewBox.EnableStartLocationSelection = MapPreviewBox.EnableContextMenu;
         }