src/SMAPI/IMultiplayerHelper.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

using System.Collections.Generic;
using StardewValley;

namespace StardewModdingAPI
{
    /// <summary>Provides multiplayer utilities.</summary>
    public interface IMultiplayerHelper : IModLinked
    {
        /// <summary>Get a new multiplayer ID.</summary>
        long GetNewID();

        /// <summary>Get the locations which are being actively synced from the host.</summary>
        IEnumerable<GameLocation> GetActiveLocations();

        /* disable until ready for release:

        /// <summary>Get a connected player.</summary>
        /// <param name="id">The player's unique ID.</param>
        /// <returns>Returns the connected player, or <c>null</c> if no such player is connected.</returns>
        IMultiplayerPeer GetConnectedPlayer(long id);

        /// <summary>Get all connected players.</summary>
        IEnumerable<IMultiplayerPeer> GetConnectedPlayers();
        */
    }
}