blob: 48efeda42ca97ec19fa168bea8066e6793242591 (
plain)
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
using System.Collections.Generic;
using System.Threading.Tasks;
using Impostor.Api.Innersloth;
using Impostor.Api.Net.Messages;
namespace Impostor.Api.Net
{
/// <summary>
/// Represents a connected game client.
/// </summary>
public interface IClient
{
/// <summary>
/// Gets or sets the unique ID of the client.
/// </summary>
/// <remarks>
/// This ID is generated when the client is registered in the client manager and should not be used
/// to store persisted data.
/// </remarks>
int Id { get; set; }
/// <summary>
/// Gets the name that was provided by the player in the client.
/// </summary>
/// <remarks>
/// The name is provided by the player and should not be used to store persisted data.
/// </remarks>
string Name { get; }
/// <summary>
/// Gets the connection of the client.
/// </summary>
/// <remarks>
/// Null when the client was not registered by the matchmaker.
/// </remarks>
IHazelConnection? Connection { get; }
/// <summary>
/// Gets a key/value collection that can be used to share data between messages.
/// </summary>
/// <remarks>
/// <para>
/// The stored data will not be saved.
/// After the connection has been closed all data will be lost.
/// </para>
/// <para>
/// Note that the values will not be disposed after the connection has been closed.
/// This has to be implemented by the plugin.
/// </para>
/// </remarks>
IDictionary<object, object> Items { get; }
/// <summary>
/// Gets or sets the current game data of the <see cref="IClient"/>.
/// </summary>
IClientPlayer? Player { get; }
ValueTask HandleMessageAsync(IMessageReader message, MessageType messageType);
ValueTask HandleDisconnectAsync(string reason);
/// <summary>
/// Disconnect the client with a <see cref="DisconnectReason"/>.
/// </summary>
/// <param name="reason">
/// The message to show to the player.
/// </param>
/// <param name="message">
/// Only used when <see cref="reason"/> is set to <see cref="DisconnectReason.Custom"/>.
/// </param>
/// <returns>
/// A <see cref="ValueTask"/> representing the asynchronous operation.
/// </returns>
ValueTask DisconnectAsync(DisconnectReason reason, string? message = null);
}
}
|
