summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2018-11-04 23:07:10 -0500
committerJesse Plamondon-Willard <github@jplamondonw.com>2018-11-04 23:07:10 -0500
commitb4a5b3829f0f738e5b7e05048068eaec9d2d01d1 (patch)
treea78c44e929ff1de70d20b012385c418aea7e78a6 /src/SMAPI/Events
parent222265816d803e8e145c0a500568412d03dd49da (diff)
downloadSMAPI-b4a5b3829f0f738e5b7e05048068eaec9d2d01d1.tar.gz
SMAPI-b4a5b3829f0f738e5b7e05048068eaec9d2d01d1.tar.bz2
SMAPI-b4a5b3829f0f738e5b7e05048068eaec9d2d01d1.zip
add PeerDisconnected event (#480)
Diffstat (limited to 'src/SMAPI/Events')
-rw-r--r--src/SMAPI/Events/IMultiplayerEvents.cs7
-rw-r--r--src/SMAPI/Events/PeerContextReceivedEventArgs.cs (renamed from src/SMAPI/Events/ContextReceivedEventArgs.cs)10
-rw-r--r--src/SMAPI/Events/PeerDisconnectedEventArgs.cs25
3 files changed, 35 insertions, 7 deletions
diff --git a/src/SMAPI/Events/IMultiplayerEvents.cs b/src/SMAPI/Events/IMultiplayerEvents.cs
index 91e0789c..4a31f48e 100644
--- a/src/SMAPI/Events/IMultiplayerEvents.cs
+++ b/src/SMAPI/Events/IMultiplayerEvents.cs
@@ -5,10 +5,13 @@ namespace StardewModdingAPI.Events
/// <summary>Events raised for multiplayer messages and connections.</summary>
public interface IMultiplayerEvents
{
- /// <summary>Raised after the mod context for a player is received. This happens before the game approves the connection, so the player does not yet exist in the game. This is the earliest point where messages can be sent to the player via SMAPI.</summary>
- event EventHandler<ContextReceivedEventArgs> ContextReceived;
+ /// <summary>Raised after the mod context for a peer is received. This happens before the game approves the connection, so the player doesn't yet exist in the game. This is the earliest point where messages can be sent to the peer via SMAPI.</summary>
+ event EventHandler<PeerContextReceivedEventArgs> PeerContextReceived;
/// <summary>Raised after a mod message is received over the network.</summary>
event EventHandler<ModMessageReceivedEventArgs> ModMessageReceived;
+
+ /// <summary>Raised after the connection with a peer is severed.</summary>
+ event EventHandler<PeerDisconnectedEventArgs> PeerDisconnected;
}
}
diff --git a/src/SMAPI/Events/ContextReceivedEventArgs.cs b/src/SMAPI/Events/PeerContextReceivedEventArgs.cs
index c715cf1c..151a295c 100644
--- a/src/SMAPI/Events/ContextReceivedEventArgs.cs
+++ b/src/SMAPI/Events/PeerContextReceivedEventArgs.cs
@@ -2,13 +2,13 @@ using System;
namespace StardewModdingAPI.Events
{
- /// <summary>Event arguments for an <see cref="IMultiplayerEvents.ContextReceived"/> event.</summary>
- public class ContextReceivedEventArgs : EventArgs
+ /// <summary>Event arguments for an <see cref="IMultiplayerEvents.PeerContextReceived"/> event.</summary>
+ public class PeerContextReceivedEventArgs : EventArgs
{
/*********
** Accessors
*********/
- /// <summary>The player whose metadata was received.</summary>
+ /// <summary>The peer whose metadata was received.</summary>
public IMultiplayerPeer Peer { get; }
@@ -16,8 +16,8 @@ namespace StardewModdingAPI.Events
** Public methods
*********/
/// <summary>Construct an instance.</summary>
- /// <param name="peer">The player to whom a connection is being established.</param>
- internal ContextReceivedEventArgs(IMultiplayerPeer peer)
+ /// <param name="peer">The peer whose metadata was received.</param>
+ internal PeerContextReceivedEventArgs(IMultiplayerPeer peer)
{
this.Peer = peer;
}
diff --git a/src/SMAPI/Events/PeerDisconnectedEventArgs.cs b/src/SMAPI/Events/PeerDisconnectedEventArgs.cs
new file mode 100644
index 00000000..8517988a
--- /dev/null
+++ b/src/SMAPI/Events/PeerDisconnectedEventArgs.cs
@@ -0,0 +1,25 @@
+using System;
+
+namespace StardewModdingAPI.Events
+{
+ /// <summary>Event arguments for an <see cref="IMultiplayerEvents.PeerDisconnected"/> event.</summary>
+ public class PeerDisconnectedEventArgs : EventArgs
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The peer who disconnected.</summary>
+ public IMultiplayerPeer Peer { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="peer">The peer who disconnected.</param>
+ internal PeerDisconnectedEventArgs(IMultiplayerPeer peer)
+ {
+ this.Peer = peer;
+ }
+ }
+}