From 02a46bf13f29ce0dd8ac2f422113083c59dae42d Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Nov 2018 01:29:01 -0400
Subject: add APIs to send/receive messages in multiplayer (#480)

---
 src/SMAPI/Events/IModEvents.cs                  |  3 ++
 src/SMAPI/Events/IMultiplayerEvents.cs          | 11 ++++++
 src/SMAPI/Events/ModMessageReceivedEventArgs.cs | 46 +++++++++++++++++++++++++
 3 files changed, 60 insertions(+)
 create mode 100644 src/SMAPI/Events/IMultiplayerEvents.cs
 create mode 100644 src/SMAPI/Events/ModMessageReceivedEventArgs.cs

(limited to 'src/SMAPI/Events')

diff --git a/src/SMAPI/Events/IModEvents.cs b/src/SMAPI/Events/IModEvents.cs
index 76da7751..bd7ab880 100644
--- a/src/SMAPI/Events/IModEvents.cs
+++ b/src/SMAPI/Events/IModEvents.cs
@@ -12,6 +12,9 @@ namespace StardewModdingAPI.Events
         /// <summary>Events raised when the player provides input using a controller, keyboard, or mouse.</summary>
         IInputEvents Input { get; }
 
+        /// <summary>Events raised for multiplayer messages and connections.</summary>
+        IMultiplayerEvents Multiplayer { get; }
+
         /// <summary>Events raised when the player data changes.</summary>
         IPlayerEvents Player { get; }
 
diff --git a/src/SMAPI/Events/IMultiplayerEvents.cs b/src/SMAPI/Events/IMultiplayerEvents.cs
new file mode 100644
index 00000000..a6ac6fd3
--- /dev/null
+++ b/src/SMAPI/Events/IMultiplayerEvents.cs
@@ -0,0 +1,11 @@
+using System;
+
+namespace StardewModdingAPI.Events
+{
+    /// <summary>Events raised for multiplayer messages and connections.</summary>
+    public interface IMultiplayerEvents
+    {
+        /// <summary>Raised after a mod message is received over the network.</summary>
+        event EventHandler<ModMessageReceivedEventArgs> ModMessageReceived;
+    }
+}
diff --git a/src/SMAPI/Events/ModMessageReceivedEventArgs.cs b/src/SMAPI/Events/ModMessageReceivedEventArgs.cs
new file mode 100644
index 00000000..b1960a22
--- /dev/null
+++ b/src/SMAPI/Events/ModMessageReceivedEventArgs.cs
@@ -0,0 +1,46 @@
+using System;
+using StardewModdingAPI.Framework.Networking;
+
+namespace StardewModdingAPI.Events
+{
+    /// <summary>Event arguments when a mod receives a message over the network.</summary>
+    public class ModMessageReceivedEventArgs : EventArgs
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying message model.</summary>
+        private readonly ModMessageModel Message;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The unique ID of the player from whose computer the message was sent.</summary>
+        public long FromPlayerID => this.Message.FromPlayerID;
+
+        /// <summary>The unique ID of the mod which sent the message.</summary>
+        public string FromModID => this.Message.FromModID;
+
+        /// <summary>A message type which can be used to decide whether it's the one you want to handle, like <c>SetPlayerLocation</c>. This doesn't need to be globally unique, so mods should check the <see cref="FromModID"/>.</summary>
+        public string Type => this.Message.Type;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="message">The received message.</param>
+        internal ModMessageReceivedEventArgs(ModMessageModel message)
+        {
+            this.Message = message;
+        }
+
+        /// <summary>Read the message data into the given model type.</summary>
+        /// <typeparam name="TModel">The message model type.</typeparam>
+        public TModel ReadAs<TModel>()
+        {
+            return this.Message.Data.ToObject<TModel>();
+        }
+    }
+}
-- 
cgit