Merge lp:~brandesign/armagetronad/0.4-conquest-output into lp:~armagetronad-dev/armagetronad/0.4-armagetronad-work

[David Brandes]

This adds the command CONDENSE_CONQUEST_OUTPUT. If set to 1 the output gets condensed into 1 line like:
Team 1, Team 2 and Team 3 where awarded 20 Points for conquering Team 4's base

[dlh (dlh)]

== Make more translatable

I think this can be cleaned up a little. It's also difficult to translate (hardcoded " and ").

I think a better solution is: build up a list of team names, and then join all of the strings except the penultimate together (either using boost::algorithm::join or a custom implementation). The last team name would be the \4 parameter to the localized string.

So, we currently have:
* player_win_conquest_specific \1 was awarded \2 points for conquering \3's base.\n

And the new localized string for the condensed message shares the same parameters with the additional \4 parameter:
* players_win_condense_conquest \1, and \4 were awarded \2 points for conquering \3's base.\n

I think localized strings should be the full string—it's easier for translators to understand. Simply adding a new localized string for " and " can be confusing and may require looking at the source code to see how it's used.

== Should this be a configurable setting?

Does this need to be a configurable setting? And if it a setting, maybe it should be enabled by default.

== Other minor critiques

* "where awarded" should be "were awarded"
* The RequestSync() you added at the end isn't necessary.
* "score > 0 ? score : -score" is abs(score), but it looks like this was copied from eTeam::AddScore().

review: Needs Fixing

[dlh (dlh)]

Can't edit comments…

This:

> I think a better solution is: build up a list of team names, and then join all of the strings except the ***penultimate*** […]

Should be:

> I think a better solution is: build up a list of team names, and then join all of the strings except the ***last*** […]

[Yann Kaiser (epsy)]

I generalised your patch and merged it. Moved most of the logic to templates for "tString << tArray<T>/std::vector<T>/std::list<T>" so that anything can pass a pointer list to a tOutput in the future.

It might still raise some localisation issues but they can be fixed as they come up. I forgot about putting abs(score) there, will do later.

=== modified file 'NEWS'
--- NEWS	2012-10-15 16:28:12 +0000
+++ NEWS	2012-10-18 13:21:34 +0000
@@ -58,6 +58,8 @@
 - user*.cfg now resides in UserConfigDir.
 - Configuration files, with the exception of legacy user*.cfg files, are no longer
   read from the var directory.
+- New command CONDENSE_CONQUEST_OUTPUT. If set to 1 the zone conquering output gets condensed into 1 line like:
+  Team 1, Team 2 and Team 3 where awarded 20 Points for conquering Team 4's base
 
 Changes since 0.3.0
 ===================

=== modified file 'language/english_base.txt'
--- language/english_base.txt	2012-10-15 16:28:12 +0000
+++ language/english_base.txt	2012-10-18 13:21:34 +0000
@@ -341,6 +341,8 @@
 win_zone_deaths_help	            A value of 1 turns it into a death zone.
 win_zone_randomness_help            Randomness factor of the initial win zone position. 0 fixes it at the arena center, 1 spreads the zone all over it.
 
+condense_conquest_output_help       Zone conquest output condensed into one line
+
 game_timeout_help					Base timeout for game state synchronisation; gives approximately the maximum time between rounds.
 last_chat_break_time_help           Last round time a player in chat mode is able to pause the timer
 extra_round_time_help               Length of an extra pause at the beginning of the round
@@ -2845,6 +2847,7 @@
 player_win_held_fortress	\1 was awarded \2 points for holding the base.\n
 player_lose_held_fortress	\1 lost \2 points for being too defensive.\n
 player_win_conquest_specific \1 was awarded \2 points for conquering \3's base.\n
+players_win_condense_conquest   \1 where awarded \2 points for conquering \3's base.\n
 player_kill_collapse        \1 was eradicated by its collapsing zone.\n
 player_win_hole             \1 got \2 points for a sacrifice for the good of the team.\n
 player_lose_hole            0xffff00ZOMG! 0xff7f00HOLER!!1!!0xRESETT \1 lost \2 points for being a cheap ass lamer.\n

=== modified file 'src/tron/zone/zFortress.cpp'
--- src/tron/zone/zFortress.cpp	2012-07-23 19:32:52 +0000
+++ src/tron/zone/zFortress.cpp	2012-10-18 13:21:34 +0000
@@ -132,6 +132,10 @@
 static bool sg_baseEnemyRespawn = false;
 static tSettingItem<bool> sg_baseEnemyRespawnConfig ("BASE_ENEMY_RESPAWN", sg_baseEnemyRespawn);
 
+//condense fort zone conquered output into one line for multiple winers.
+static bool sg_condenseConquestOutput = false;
+static tSettingItem<bool> sg_condenseConquestOutputConfig("CONDENSE_CONQUEST_OUTPUT", sg_condenseConquestOutput);
+
 void zFortressZone::setupVisuals(gParser::State_t & state)
 {
     REAL tpR[] = {.0f, .3f};
@@ -524,9 +528,64 @@
         }
 
         int score = totalScore / (int)enemies_.size();
+        int tCount = 0;
+        tColoredString TeamOutputNames;
+        tColoredString lastTeam;
         for ( TeamArray::iterator iter = enemies_.begin(); iter != enemies_.end(); ++iter )
         {
-            (*iter)->AddScore( score, win, tOutput() );
+            if ( sg_condenseConquestOutput )
+            {
+                (*iter)->AddScore( score);
+
+                if ( tCount == 0 )
+                {
+                    lastTeam = (*iter)->GetColoredName();
+                }
+                else if ( tCount == 1 )
+                {
+                    TeamOutputNames << lastTeam;
+                    lastTeam = (*iter)->GetColoredName();
+                }
+                else
+                {
+                    TeamOutputNames << tColoredString::ColorString(1,1,1) << ", " << lastTeam;
+                    lastTeam = (*iter)->GetColoredName();
+                }
+
+                tCount++;
+            }
+            else
+            {
+                (*iter)->AddScore( score, win, tOutput() );
+            }
+        }
+
+        if ( sg_condenseConquestOutput )
+        {
+            if ( tCount == 1 )
+            {
+                TeamOutputNames << tColoredString::ColorString(1,1,1) << lastTeam;
+            }
+            else
+            {
+                TeamOutputNames << tColoredString::ColorString(1,1,1) << " and " << lastTeam;
+            }
+
+            tOutput message;
+            message.SetTemplateParameter(1, TeamOutputNames);
+            message.SetTemplateParameter(2, score > 0 ? score : -score);
+            message.SetTemplateParameter(3, team->GetColoredName());
+            if ( tCount == 1 )
+            {
+                message << "$player_win_conquest_specific";
+            }
+            else
+            {
+                message << "$players_win_condense_conquest";
+            }
+
+            sn_ConsoleOut(message);
+            RequestSync(true);
         }
     }
 
@@ -536,7 +595,6 @@
         static const char* message="$player_win_conquest";
         sg_DeclareWinner( enemies_[0], message );
     }
-
     CheckSurvivor();
 }