diff --git a/OpenRA.Game/GameInformation.cs b/OpenRA.Game/GameInformation.cs index fd30f187ff..50ceef446b 100644 --- a/OpenRA.Game/GameInformation.cs +++ b/OpenRA.Game/GameInformation.cs @@ -24,13 +24,13 @@ namespace OpenRA public string MapUid; public string MapTitle; + /// Game start timestamp (when the recoding started). public DateTime StartTimeUtc; - // Game end timestamp (when the recoding stopped). + /// Game end timestamp (when the recoding stopped). public DateTime EndTimeUtc; - // Gets the game's duration, from the time the game started until the - // replay recording stopped. + /// Gets the game's duration, from the time the game started until the replay recording stopped. public TimeSpan Duration { get { return EndTimeUtc > StartTimeUtc ? EndTimeUtc - StartTimeUtc : TimeSpan.Zero; } } public IList Players { get; private set; } public MapPreview MapPreview { get { return Game.ModData.MapCache[MapUid]; } } @@ -90,7 +90,7 @@ namespace OpenRA return nodes.WriteToString(); } - // Adds the player information at start-up. + /// Adds the player information at start-up. public void AddPlayer(OpenRA.Player runtimePlayer, Session lobbyInfo) { if (runtimePlayer == null) @@ -127,7 +127,7 @@ namespace OpenRA Players.Add(player); } - // Gets the player information for the specified runtime player instance. + /// Gets the player information for the specified runtime player instance. public Player GetPlayer(OpenRA.Player runtimePlayer) { Player player; @@ -139,38 +139,43 @@ namespace OpenRA public class Player { - // Start-up information + #region Start-up information + public int ClientIndex; - // The player name, not guaranteed to be unique. + /// The player name, not guaranteed to be unique. public string Name; public bool IsHuman; public bool IsBot; - // The faction's display name. + /// The faction's display name. public string FactionName; - // The faction ID, a.k.a. the faction's internal name. + /// The faction ID, a.k.a. the faction's internal name. public string FactionId; public HSLColor Color; - // The team id on start-up, or 0 if the player is not part of the team. + /// The team ID on start-up, or 0 if the player is not part of a team. public int Team; public int SpawnPoint; - // True if the faction was chosen at random; otherwise, false + /// True if the faction was chosen at random; otherwise, false. public bool IsRandomFaction; - // True if the spawn point was chosen at random; otherwise, false. + /// True if the spawn point was chosen at random; otherwise, false. public bool IsRandomSpawnPoint; - // Information gathered at a later stage + #endregion - // The game outcome for this player + #region + + /// The game outcome for this player. public WinState Outcome; - // The time when this player won or lost the game + /// The time when this player won or lost the game. public DateTime OutcomeTimestampUtc; + + #endregion } } }