Merge branch 'master' into master

Author: Maldark

Torch.API/ITorchBase.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -8,37 +8,105 @@
 
 namespace Torch.API
 {
+    /// <summary>
+    /// API for Torch functions shared between client and server.
+    /// </summary>
     public interface ITorchBase
     {
+        /// <summary>
+        /// Fired when the session begins loading.
+        /// </summary>
         event Action SessionLoading;
+        
+        /// <summary>
+        /// Fired when the session finishes loading.
+        /// </summary>
         event Action SessionLoaded;
+
+        /// <summary>
+        /// Fires when the session begins unloading.
+        /// </summary>
         event Action SessionUnloading;
+
+        /// <summary>
+        /// Fired when the session finishes unloading.
+        /// </summary>
         event Action SessionUnloaded;
+
+        /// <summary>
+        /// Configuration for the current instance.
+        /// </summary>
         ITorchConfig Config { get; }
+
+        /// <inheritdoc cref="IMultiplayerManager"/>
         IMultiplayerManager Multiplayer { get; }
+
+        /// <inheritdoc cref="IPluginManager"/>
         IPluginManager Plugins { get; }
+
+        /// <summary>
+        /// The binary version of the current instance.
+        /// </summary>
         Version TorchVersion { get; }
+
+        /// <summary>
+        /// Invoke an action on the game thread.
+        /// </summary>
         void Invoke(Action action);
+
+        /// <summary>
+        /// Invoke an action on the game thread and block until it has completed.
+        /// If this is called on the game thread the action will execute immediately.
+        /// </summary>
         void InvokeBlocking(Action action);
+
+        /// <summary>
+        /// Invoke an action on the game thread asynchronously.
+        /// </summary>
         Task InvokeAsync(Action action);
-        string[] RunArgs { get; set; }
-        bool IsOnGameThread();
+
+        /// <summary>
+        /// Start the Torch instance.
+        /// </summary>
         void Start();
+
+        /// <summary>
+        /// Stop the Torch instance.
+        /// </summary>
         void Stop();
+      
         /// <summary>
         /// Initializes a save of the game.
         /// </summary>
         /// <param name="callerId">Id of the player who initiated the save.</param>
         void Save(long callerId);
+
+        /// <summary>
+        /// Initialize the Torch instance.
+        /// </summary>
         void Init();
+
+        /// <summary>
+        /// Get an <see cref="IManager"/> that is part of the Torch instance.
+        /// </summary>
+        /// <typeparam name="T">Manager type</typeparam>
         T GetManager<T>() where T : class, IManager;
     }
 
+    /// <summary>
+    /// API for the Torch server.
+    /// </summary>
     public interface ITorchServer : ITorchBase
     {
+        /// <summary>
+        /// Path of the dedicated instance folder.
+        /// </summary>
         string InstancePath { get; }
     }
 
+    /// <summary>
+    /// API for the Torch client.
+    /// </summary>
     public interface ITorchClient : ITorchBase
     {
 

Torch.API/ITorchConfig.cs

@@ -1,14 +1,47 @@
-namespace Torch
+using System.Collections.Generic;
+
+namespace Torch
 {
     public interface ITorchConfig
     {
+        /// <summary>
+        /// (server) Name of the instance.
+        /// </summary>
         string InstanceName { get; set; }
+
+        /// <summary>
+        /// (server) Dedicated instance path.
+        /// </summary>
         string InstancePath { get; set; }
-        bool RedownloadPlugins { get; set; }
-        bool AutomaticUpdates { get; set; }
+
+        /// <summary>
+        /// Enable automatic Torch updates.
+        /// </summary>
+        bool GetTorchUpdates { get; set; }
+
+        /// <summary>
+        /// Enable automatic Torch updates.
+        /// </summary>
+        bool GetPluginUpdates { get; set; }
+
+        /// <summary>
+        /// Restart Torch automatically if it crashes.
+        /// </summary>
         bool RestartOnCrash { get; set; }
+
+        /// <summary>
+        /// Time-out in seconds for the Torch watchdog (to detect a hung session).
+        /// </summary>
         int TickTimeout { get; set; }
 
+        /// <summary>
+        /// A list of plugins that should be installed.
+        /// </summary>
+        List<string> Plugins { get; }
+        
+        /// <summary>
+        /// Saves the config.
+        /// </summary>
         bool Save(string path = null);
     }
 }

Torch.API/Managers/IManager.cs

@@ -6,8 +6,14 @@
 
 namespace Torch.API.Managers
 {
+    /// <summary>
+    /// Base interface for Torch managers.
+    /// </summary>
     public interface IManager
     {
+        /// <summary>
+        /// Initializes the manager. Called after Torch is initialized.
+        /// </summary>
         void Init();
     }
 }

Torch.API/Managers/IMultiplayerManager.cs

@@ -6,17 +6,56 @@
 
 namespace Torch.API.Managers
 {
+    /// <summary>
+    /// Delegate for received messages.
+    /// </summary>
+    /// <param name="message">Message data.</param>
+    /// <param name="sendToOthers">Flag to broadcast message to other players.</param>
     public delegate void MessageReceivedDel(IChatMessage message, ref bool sendToOthers);
 
+    /// <summary>
+    /// API for multiplayer related functions.
+    /// </summary>
     public interface IMultiplayerManager : IManager
     {
+        /// <summary>
+        /// Fired when a player joins.
+        /// </summary>
         event Action<IPlayer> PlayerJoined;
+
+        /// <summary>
+        /// Fired when a player disconnects.
+        /// </summary>
         event Action<IPlayer> PlayerLeft;
+
+        /// <summary>
+        /// Fired when a chat message is received.
+        /// </summary>
         event MessageReceivedDel MessageReceived;
+
+        /// <summary>
+        /// Send a chat message to all or one specific player.
+        /// </summary>
         void SendMessage(string message, string author = "Server", long playerId = 0, string font = MyFontEnum.Blue);
+
+        /// <summary>
+        /// Kicks the player from the game.
+        /// </summary>
         void KickPlayer(ulong steamId);
+
+        /// <summary>
+        /// Bans or unbans a player from the game.
+        /// </summary>
         void BanPlayer(ulong steamId, bool banned = true);
+
+        /// <summary>
+        /// Gets a player by their Steam64 ID or returns null if the player isn't found.
+        /// </summary>
         IMyPlayer GetPlayerBySteamId(ulong id);
+
+        /// <summary>
+        /// Gets a player by their display name or returns null if the player isn't found.
+        /// </summary>
         IMyPlayer GetPlayerByName(string name);
     }
 }

Torch.API/Managers/INetworkManager.cs

@@ -9,14 +9,30 @@
 
 namespace Torch.API.Managers
 {
+    /// <summary>
+    /// API for the network intercept.
+    /// </summary>
     public interface INetworkManager : IManager
     {
+        /// <summary>
+        /// Register a network handler.
+        /// </summary>
         void RegisterNetworkHandler(INetworkHandler handler);
     }
 
+    /// <summary>
+    /// Handler for multiplayer network messages.
+    /// </summary>
     public interface INetworkHandler
     {
+        /// <summary>
+        /// Returns if the handler can process the call site.
+        /// </summary>
         bool CanHandle(CallSite callSite);
+
+        /// <summary>
+        /// Processes a network message.
+        /// </summary>
         bool Handle(ulong remoteUserId, CallSite site, BitStream stream, object obj, MyPacket packet);
     }
 }

Torch.API/Managers/IPluginManager.cs

@@ -6,11 +6,29 @@
 
 namespace Torch.API.Managers
 {
+    /// <summary>
+    /// API for the Torch plugin manager.
+    /// </summary>
     public interface IPluginManager : IManager, IEnumerable<ITorchPlugin>
     {
+        /// <summary>
+        /// Fired when plugins are loaded.
+        /// </summary>
         event Action<List<ITorchPlugin>> PluginsLoaded;
-        List<ITorchPlugin> Plugins { get; }
+
+        /// <summary>
+        /// Collection of loaded plugins.
+        /// </summary>
+        ObservableCollection<ITorchPlugin> Plugins { get; }
+
+        /// <summary>
+        /// Updates all loaded plugins.
+        /// </summary>
         void UpdatePlugins();
+
+        /// <summary>
+        /// Disposes all loaded plugins.
+        /// </summary>
         void DisposePlugins();
     }
 }

Torch.API/ServerState.cs

@@ -6,11 +6,29 @@
 
 namespace Torch.API
 {
+    /// <summary>
+    /// Used to indicate the state of the dedicated server.
+    /// </summary>
     public enum ServerState
     {
+        /// <summary>
+        /// The server is not running.
+        /// </summary>
         Stopped,
+
+        /// <summary>
+        /// The server is starting/loading the session.
+        /// </summary>
         Starting,
+
+        /// <summary>
+        /// The server is running.
+        /// </summary>
         Running,
+
+        /// <summary>
+        /// The server encountered an error.
+        /// </summary>
         Error
     }
 }

Torch.Client/Properties/AssemblyInfo.cs

@@ -1,4 +1,4 @@
 using System.Reflection;
 
-[assembly: AssemblyVersion("1.0.182.329")]
-[assembly: AssemblyFileVersion("1.0.182.329")]
+[assembly: AssemblyVersion("1.0.186.642")]
+[assembly: AssemblyFileVersion("1.0.186.642")]

Torch.Client/Torch.Client.csproj

@@ -45,6 +45,10 @@
       <HintPath>..\packages\NLog.4.4.1\lib\net45\NLog.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="Sandbox.Common, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\GameBinaries\Sandbox.Common.dll</HintPath>
+    </Reference>
     <Reference Include="Sandbox.Game">
       <HintPath>..\GameBinaries\Sandbox.Game.dll</HintPath>
       <Private>False</Private>

Torch.Client/TorchClient.cs

@@ -9,6 +9,7 @@
 using Sandbox.Engine.Platform;
 using Sandbox.Engine.Utils;
 using Sandbox.Game;
+using Sandbox.ModAPI;
 using SpaceEngineers.Game;
 using Torch.API;
 using VRage.FileSystem;