Client IPlayerSession Interface. (#696)

* Added new IPlayerSession interface to client.
Removed session interfaces out of the lame `Interfaces` namespace.

* Fixed a doc comment.

SS14.Client.Godot/MainScene.tscn

@@ -2,6 +2,8 @@
 
 [ext_resource path="res://SS14Loader.cs" type="Script" id=1]
 
-[node name="MainScene" type="Node"]
+[node name="MainScene" type="Node" index="0"]
+
 script = ExtResource( 1 )
 
+

SS14.Client/BaseClient.cs

@@ -1,7 +1,6 @@
 using System;
 using SS14.Client.Interfaces;
 using SS14.Client.Interfaces.GameObjects;
-using SS14.Client.Interfaces.Player;
 using SS14.Client.Interfaces.State;
 using SS14.Client.Player;
 using SS14.Client.State.States;

SS14.Client/Console/ClientChatConsole.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 using SS14.Client.Interfaces.GameObjects;
-using SS14.Client.Interfaces.Player;
+using SS14.Client.Player;
 using SS14.Client.UserInterface.CustomControls;
 using SS14.Shared.Console;
 using SS14.Shared.GameObjects;

SS14.Client/GameController/GameController.IoC.cs

@@ -11,7 +11,6 @@
 using SS14.Client.Interfaces.Graphics.Lighting;
 using SS14.Client.Interfaces.Input;
 using SS14.Client.Interfaces.Map;
-using SS14.Client.Interfaces.Player;
 using SS14.Client.Interfaces.ResourceManagement;
 using SS14.Client.Interfaces.State;
 using SS14.Client.Interfaces.UserInterface;

SS14.Client/GameObjects/EntitySystems/InputSystem.cs

@@ -1,7 +1,7 @@
 using System;
 using SS14.Client.GameObjects.Components;
 using SS14.Client.Interfaces.Input;
-using SS14.Client.Interfaces.Player;
+using SS14.Client.Player;
 using SS14.Shared.GameObjects;
 using SS14.Shared.GameObjects.Systems;
 using SS14.Shared.Input;

SS14.Client/GameStates/ClientGameStateManager.cs

@@ -1,7 +1,6 @@
 using SS14.Client.Interfaces;
 using SS14.Client.Interfaces.GameObjects;
 using SS14.Client.Interfaces.GameStates;
-using SS14.Client.Interfaces.Player;
 using SS14.Shared;
 using SS14.Shared.GameStates;
 using SS14.Shared.Interfaces.Network;
@@ -12,6 +11,7 @@
 using SS14.Shared.Network.Messages;
 using System.Collections.Generic;
 using System.Linq;
+using SS14.Client.Player;
 
 namespace SS14.Client.GameStates
 {

SS14.Client/Placement/PlacementManager.cs

@@ -6,7 +6,6 @@
 using SS14.Client.Interfaces.Graphics.ClientEye;
 using SS14.Client.Interfaces.Input;
 using SS14.Client.Interfaces.Placement;
-using SS14.Client.Interfaces.Player;
 using SS14.Client.Interfaces.ResourceManagement;
 using SS14.Client.ResourceManagement;
 using SS14.Shared.Enums;
@@ -28,6 +27,7 @@
 using SS14.Client.Graphics;
 using SS14.Client.GameObjects;
 using SS14.Client.GameObjects.EntitySystems;
+using SS14.Client.Player;
 using SS14.Shared.Input;
 using SS14.Shared.Utility;
 using SS14.Shared.Serialization;

SS14.Client/Interfaces/Player/IPlayerManager.cs → SS14.Client/Player/IPlayerManager.cs

@@ -1,16 +1,16 @@
 using System;
 using System.Collections.Generic;
-using SS14.Client.Player;
 using SS14.Shared.GameStates;
 using SS14.Shared.Interfaces.Network;
 using SS14.Shared.Network;
+using SS14.Shared.Players;
 
-namespace SS14.Client.Interfaces.Player
+namespace SS14.Client.Player
 {
     public interface IPlayerManager
     {
-        IEnumerable<PlayerSession> Sessions { get; }
-        IReadOnlyDictionary<NetSessionId, PlayerSession> SessionsDict { get; }
+        IEnumerable<IPlayerSession> Sessions { get; }
+        IReadOnlyDictionary<NetSessionId, IPlayerSession> SessionsDict { get; }
 
         LocalPlayer LocalPlayer { get; }
 
@@ -22,8 +22,7 @@ public interface IPlayerManager
         void Startup(INetChannel channel);
         void Update(float frameTime);
         void Shutdown();
-
-        //void ApplyEffects(RenderImage image);
+
         void ApplyPlayerStates(IEnumerable<PlayerState> list);
     }
 }

SS14.Client/Player/IPlayerSession.cs

@@ -0,0 +1,20 @@
+using SS14.Shared.Players;
+
+namespace SS14.Client.Player
+{
+    /// <summary>
+    ///     Client side session of a player.
+    /// </summary>
+    public interface IPlayerSession : ICommonSession
+    {
+        /// <summary>
+        ///     Current name of this player.
+        /// </summary>
+        new string Name { get; set; }
+
+        /// <summary>
+        ///     Current connection latency of this session from the server to their client.
+        /// </summary>
+        short Ping { get; set; }
+    }
+}

SS14.Client/Player/PlayerManager.cs

@@ -1,10 +1,7 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using SS14.Client.Interfaces;
-using SS14.Client.Interfaces.Player;
-using SS14.Shared;
 using SS14.Shared.Configuration;
 using SS14.Shared.Enums;
 using SS14.Shared.GameObjects;
@@ -15,6 +12,7 @@
 using SS14.Shared.IoC;
 using SS14.Shared.Network;
 using SS14.Shared.Network.Messages;
+using SS14.Shared.Players;
 using SS14.Shared.Utility;
 
 namespace SS14.Client.Player
@@ -43,7 +41,7 @@ public class PlayerManager : IPlayerManager
         /// <summary>
         ///     Active sessions of connected clients to the server.
         /// </summary>
-        private Dictionary<NetSessionId, PlayerSession> _sessions;
+        private Dictionary<NetSessionId, IPlayerSession> _sessions;
 
         /// <inheritdoc />
         public int PlayerCount => _sessions.Values.Count;
@@ -55,18 +53,18 @@ public class PlayerManager : IPlayerManager
         public LocalPlayer LocalPlayer { get; private set; }
 
         /// <inheritdoc />
-        public IEnumerable<PlayerSession> Sessions => _sessions.Values;
+        public IEnumerable<IPlayerSession> Sessions => _sessions.Values;
 
         /// <inheritdoc />
-        public IReadOnlyDictionary<NetSessionId, PlayerSession> SessionsDict => _sessions;
+        public IReadOnlyDictionary<NetSessionId, IPlayerSession> SessionsDict => _sessions;
 
         /// <inheritdoc />
         public event EventHandler PlayerListUpdated;
 
         /// <inheritdoc />
         public void Initialize()
         {
-            _sessions = new Dictionary<NetSessionId, PlayerSession>();
+            _sessions = new Dictionary<NetSessionId, IPlayerSession>();
 
             _config.RegisterCVar("player.name", "Joe Genero", CVar.ARCHIVE);
 
@@ -243,31 +241,5 @@ private void UpdatePlayerList(IEnumerable<PlayerState> remotePlayers)
                 PlayerListUpdated?.Invoke(this, EventArgs.Empty);
             }
         }
-        /*
-        private void AddEffect(PostProcessingEffectType type, float duration)
-        {
-            PostProcessingEffect e;
-            switch (type)
-            {
-                case PostProcessingEffectType.Blur:
-                    e = new BlurPostProcessingEffect(duration);
-                    e.OnExpired += EffectExpired;
-                    _effects.Add(e);
-                    break;
-                case PostProcessingEffectType.Death:
-                    e = new DeathPostProcessingEffect(duration);
-                    e.OnExpired += EffectExpired;
-                    _effects.Add(e);
-                    break;
-            }
-        }
-
-        private void EffectExpired(PostProcessingEffect effect)
-        {
-            effect.OnExpired -= EffectExpired;
-            if (_effects.Contains(effect))
-                _effects.Remove(effect);
-        }
-        */
     }
 }

SS14.Client/Player/PlayerSession.cs

@@ -1,29 +1,21 @@
 using SS14.Shared.Enums;
 using SS14.Shared.Network;
-using SS14.Shared.Players;
 
 namespace SS14.Client.Player
 {
-    /// <summary>
-    ///     Client side session of a player.
-    /// </summary>
-    public class PlayerSession : ICommonSession
+
+    public class PlayerSession : IPlayerSession
     {
-        /// <summary>
-        ///     Status of the session.
-        /// </summary>
+        /// <inheritdoc />
         public SessionStatus Status { get; set; } = SessionStatus.Connecting;
 
+        /// <inheritdoc />
         public NetSessionId SessionId { get; }
 
-        /// <summary>
-        ///     Current name of this player.
-        /// </summary>
+        /// <inheritdoc cref="IPlayerSession" />
         public string Name { get; set; } = "<Unknown>";
 
-        /// <summary>
-        ///     Current connection latency of this session from the server to their client.
-        /// </summary>
+        /// <inheritdoc />
         public short Ping { get; set; }
 
         /// <summary>

SS14.Client/SS14.Client.csproj

@@ -154,7 +154,8 @@
     <Compile Include="Interfaces\IBaseClient.cs" />
     <Compile Include="Interfaces\ISceneTreeHolder.cs" />
     <Compile Include="Interfaces\Map\IClientTileDefinitionManager.cs" />
-    <Compile Include="Interfaces\Player\IPlayerManager.cs" />
+    <Compile Include="Player\IPlayerManager.cs" />
+    <Compile Include="Player\IPlayerSession.cs" />
     <Compile Include="Interfaces\State\IStateManager.cs" />
     <Compile Include="Interfaces\Utility\IRand.cs" />
     <Compile Include="Log\DebugConsoleLogHandler.cs" />

SS14.Client/State/States/GameScreen.cs

@@ -5,7 +5,6 @@
 using SS14.Client.Interfaces.Graphics.ClientEye;
 using SS14.Client.Interfaces.Input;
 using SS14.Client.Interfaces.Placement;
-using SS14.Client.Interfaces.Player;
 using SS14.Client.Interfaces.UserInterface;
 using SS14.Client.UserInterface.CustomControls;
 using SS14.Shared.GameObjects;
@@ -17,6 +16,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using SS14.Client.GameObjects.EntitySystems;
+using SS14.Client.Player;
 using SS14.Shared.Interfaces.Timing;
 
 namespace SS14.Client.State.States

SS14.Client/State/States/LobbyMenu.cs

@@ -1,5 +1,4 @@
 using SS14.Client.Console;
-using SS14.Client.Interfaces.Player;
 using SS14.Shared.IoC;
 
 namespace SS14.Client.State.States

SS14.Client/UserInterface/CustomControls/DebugCoordsPanel.cs

@@ -1,6 +1,5 @@
 using SS14.Client.Interfaces.Graphics.ClientEye;
 using SS14.Client.Interfaces.Input;
-using SS14.Client.Interfaces.Player;
 using SS14.Client.UserInterface.Controls;
 using SS14.Shared.Interfaces.GameObjects.Components;
 using SS14.Shared.IoC;
@@ -11,6 +10,7 @@
 using SS14.Client.ResourceManagement;
 using SS14.Client.Graphics.Drawing;
 using SS14.Client.Interfaces.State;
+using SS14.Client.Player;
 using SS14.Client.State.States;
 using SS14.Shared.Interfaces.GameObjects;
 using SS14.Shared.Utility;

SS14.Shared/Players/IBaseSession.cs

@@ -7,6 +7,9 @@ namespace SS14.Shared.Players
     /// </summary>
     public interface IBaseSession
     {
+        /// <summary>
+        ///     The UID of this session.
+        /// </summary>
         NetSessionId SessionId { get; }
 
         /// <summary>

SS14.UnitTesting/SS14UnitTest.cs

@@ -68,6 +68,7 @@
 using SS14.Shared.Timers;
 using SS14.Shared.Timing;
 using SS14.UnitTesting.Client;
+using IPlayerManager = SS14.Client.Player.IPlayerManager;
 
 namespace SS14.UnitTesting
 {
@@ -196,7 +197,7 @@ private void RegisterIoC()
                     IoCManager.Register<IEntityNetworkManager, ClientEntityNetworkManager>();
                     IoCManager.Register<IClientGameStateManager, ClientGameStateManager>();
                     IoCManager.Register<IBaseClient, BaseClient>();
-                    IoCManager.Register<SS14.Client.Interfaces.Player.IPlayerManager, SS14.Client.Player.PlayerManager>();
+                    IoCManager.Register<IPlayerManager, SS14.Client.Player.PlayerManager>();
                     IoCManager.Register<IStateManager, StateManager>();
                     IoCManager.Register<IUserInterfaceManager, DummyUserInterfaceManager>();
                     IoCManager.Register<IGameControllerProxy, GameControllerProxyDummy>();
@@ -228,7 +229,7 @@ private void RegisterIoC()
                     IoCManager.Register<IServerGameStateManager, ServerGameStateManager>();
                     IoCManager.Register<IReflectionManager, ServerReflectionManager>();
                     IoCManager.Register<IConsoleShell, ConsoleShell>();
-                    IoCManager.Register<IPlayerManager, PlayerManager>();
+                    IoCManager.Register<SS14.Server.Interfaces.Player.IPlayerManager, PlayerManager>();
                     IoCManager.Register<IComponentFactory, ServerComponentFactory>();
                     IoCManager.Register<IBaseServer, BaseServer>();
                     IoCManager.Register<IMapLoader, MapLoader>();