Broaden search for "solo" PlayerSide, including a side in comma-separ…

…ated list "VassalSkipSideList". VassalSkipSideList is a Global Translatable Message property.
vassalengine · Sep 3, 2023 · b9be8a5 · b9be8a5 · riverwanderer · Sep 3, 2023
1 parent 903d382
commit b9be8a5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/vassal-app/src/main/java/VASSAL/build/module/PlayerRoster.java b/vassal-app/src/main/java/VASSAL/build/module/PlayerRoster.java
@@ -622,15 +622,16 @@ protected boolean allSidesAllocated() {
 
   /**
    * @param side Name of a side to see if it's a "solo side"
-   * @return True if the side is "Solo" or begins "Solitaire", "Solo:", "Moderator", "Referee" or "."
+   * @return True if the side is "Solo" or begins "Solitaire", "Solo:", "Moderator", "Referee" or a Side
+   * found in the Global Translatable Message Property: VassalSkipSideList (a comma-separated list).
    */
   public static boolean isSoloSide(String side) {
     return side.startsWith(Resources.getString("PlayerRoster.solitaire")) ||
             side.equals(Resources.getString("PlayerRoster.solo")) ||
             side.startsWith(Resources.getString("PlayerRoster.solo") + ":") ||
             side.startsWith(Resources.getString("PlayerRoster.moderator")) ||
             side.startsWith(Resources.getString("PlayerRoster.referee")) ||
-            side.startsWith(" ");
+            ("," + GameModule.getGameModule().getLocalizedProperty("VassalSkipSideList") + ",").contains("," + side + ",");
   }
 
   /**

diff --git a/vassal-doc/src/main/readme-referencemanual/ReferenceManual/GameModule.adoc b/vassal-doc/src/main/readme-referencemanual/ReferenceManual/GameModule.adoc
@@ -117,7 +117,7 @@ Only one player may be assigned to a side.
 When joining a game, players will be prompted to take one of the remaining available sides.
 Any number of observers (players who belong to no side) are allowed.
 
-When prompting for a side, a next default entry is offered. Certain names are skipped in this process; these are "Solo" and names beginning "Solitaire", "Solo:", "Moderator", "Referee" or a space character. The later may be used to skip any auxiliary sides with any arbitrary name.
+When prompting for a side, a next default entry is offered. Certain names are skipped in this process; these are "Solo" and names beginning "Solitaire", "Solo:", "Moderator", "Referee" or name found in the <<GlobalTranslatableMessages.adoc#top, Global Translatable Messages>> property _VassalSkipSideList_. If used, the later should be defined as a comma-separated list of Sides.
 
 The <<Toolbar.adoc#Retire,Retire>> or <<Toolbar.adoc#SwitchSides,Switch Sides>> button, in the main controls toolbar, allows a player to relinquish their side (making it available to the next player joining the game). You can specify the text, icon, and mouse-over tooltip for the toolbar button.
 |===