Repository navigation
Expand file tree
/
Copy pathIStats.cs
More file actions
302 lines (259 loc) · 15.7 KB
/
Copy pathIStats.cs
File metadata and controls
302 lines (259 loc) · 15.7 KB
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
using System;
namespace SS.Core.ComponentInterfaces
{
/// <summary>
/// Identifies a stat and its type.
/// </summary>
/// <typeparam name="T">
/// The type of stat.
/// </typeparam>
/// <remarks>
/// The type parameter, <typeparamref name="T"/>, is a bit strange.
/// The purpose of it is to help protect against mismatching a StatId and its type.
/// The idea being, you keep a static class containing your StatCodes, similar to the <see cref="StatCodes"/> class.
/// </remarks>
public struct StatCode<T> where T : struct
{
public int StatId { get; private set; }
public StatCode(int statId)
{
StatId = statId;
}
public StatCode(StatId statId)
{
StatId = (int)statId;
}
}
/// <summary>
/// Interface for managing statistics on players that affects global (zone-wide) stats only.
/// </summary>
public interface IGlobalPlayerStats : IComponentInterface
{
#region IncrementStat methods
/// <summary>
/// Increments a player's statistic.
/// </summary>
/// <param name="player">The player to increment the stat for.</param>
/// <param name="statCode">The statistic to increment.</param>
/// <param name="interval">The interval to increment that stat for. <see langword="null"/> means all intervals.</param>
/// <param name="amount">The amount to increment by.</param>
void IncrementStat(Player player, StatCode<int> statCode, PersistInterval? interval, int amount);
///<inheritdoc cref="IncrementStat"/>
void IncrementStat(Player player, StatCode<long> statCode, PersistInterval? interval, long amount);
///<inheritdoc cref="IncrementStat"/>
void IncrementStat(Player player, StatCode<uint> statCode, PersistInterval? interval, uint amount);
///<inheritdoc cref="IncrementStat"/>
void IncrementStat(Player player, StatCode<ulong> statCode, PersistInterval? interval, ulong amount);
///<inheritdoc cref="IncrementStat"/>
void IncrementStat(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval, TimeSpan amount);
#endregion
#region SetStat methods
/// <summary>
/// Sets a player's statistic to a specified value.
/// </summary>
/// <param name="player">The player to set the stat for.</param>
/// <param name="statCode">The statistic to set.</param>
/// <param name="interval">The interval to set the stat for.</param>
/// <param name="value">The value to set.</param>
void SetStat(Player player, StatCode<int> statCode, PersistInterval interval, int value);
///<inheritdoc cref="SetStat"/>
void SetStat(Player player, StatCode<long> statCode, PersistInterval interval, long value);
///<inheritdoc cref="SetStat"/>
void SetStat(Player player, StatCode<uint> statCode, PersistInterval interval, uint value);
///<inheritdoc cref="SetStat"/>
void SetStat(Player player, StatCode<ulong> statCode, PersistInterval interval, ulong value);
///<inheritdoc cref="SetStat"/>
void SetStat(Player player, StatCode<DateTime> statCode, PersistInterval interval, DateTime value);
///<inheritdoc cref="SetStat"/>
void SetStat(Player player, StatCode<TimeSpan> statCode, PersistInterval interval, TimeSpan value);
#endregion
#region TryGetStat methods
/// <summary>
/// Gets the value of a player's statistic.
/// </summary>
/// <param name="player">The player to get the stat for.</param>
/// <param name="statCode">The statistic to get.</param>
/// <param name="interval">The interval to get the stat for.</param>
/// <param name="value">The value, if the stat could be found; otherwise the default value of the type.</param>
/// <returns>Whether the stat could be found.</returns>
bool TryGetStat(Player player, StatCode<int> statCode, PersistInterval interval, out int value);
///<inheritdoc cref="TryGetStat"/>
bool TryGetStat(Player player, StatCode<long> statCode, PersistInterval interval, out long value);
///<inheritdoc cref="TryGetStat"/>
bool TryGetStat(Player player, StatCode<uint> statCode, PersistInterval interval, out uint value);
///<inheritdoc cref="TryGetStat"/>
bool TryGetStat(Player player, StatCode<ulong> statCode, PersistInterval interval, out ulong value);
///<inheritdoc cref="TryGetStat"/>
bool TryGetStat(Player player, StatCode<DateTime> statCode, PersistInterval interval, out DateTime value);
///<inheritdoc cref="TryGetStat"/>
bool TryGetStat(Player player, StatCode<TimeSpan> statCode, PersistInterval interval, out TimeSpan value);
#endregion
#region Timer (TimeSpan stat) methods
/// <summary>
/// Starts the timer for a TimeSpan stat, which acts like a stopwatch.
/// </summary>
/// <param name="player">The player to start the timer for.</param>
/// <param name="statCode">The timer statistic to start.</param>
/// <param name="interval">The interval to start the timer for. <see langword="null"/> means all intervals.</param>
void StartTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
/// <summary>
/// Stops the timer for a TimeSpan stat, which acts like a stopwatch.
/// </summary>
/// <param name="player">The player to stop the timer for.</param>
/// <param name="statCode">The timer statistic to stop.</param>
/// <param name="interval">The interval to stop the timer for. <see langword="null"/> means all intervals.</param>
void StopTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
/// <summary>
/// Reset the timer for a TimeSpan stat, which acts like a stopwatch.
/// Resetting a timer stops the timer and resets the elapsed duration back to zero.
/// </summary>
/// <param name="player">The player to reset the timer for.</param>
/// <param name="statCode">The timer statistic to reset.</param>
/// <param name="interval">The interval to reset the timer for. <see langword="null"/> means all intervals.</param>
void ResetTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
#endregion
}
/// <summary>
/// Interface for managing statistics on players that affects current arena stats only.
/// </summary>
/// <remarks>
/// This is the equivalent of the IStats interface in ASSS since it only tracks stats per-arena.
/// </remarks>
public interface IArenaPlayerStats : IComponentInterface
{
#region IncrementStat methods
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<int> statCode, PersistInterval? interval, int amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<long> statCode, PersistInterval? interval, long amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<uint> statCode, PersistInterval? interval, uint amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<ulong> statCode, PersistInterval? interval, ulong amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval, TimeSpan amount);
#endregion
#region SetStat methods
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<int> statCode, PersistInterval interval, int value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<long> statCode, PersistInterval interval, long value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<uint> statCode, PersistInterval interval, uint value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<ulong> statCode, PersistInterval interval, ulong value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<DateTime> statCode, PersistInterval interval, DateTime value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<TimeSpan> statCode, PersistInterval interval, TimeSpan value);
#endregion
#region TryGetStat methods
/// <inheritdoc cref="IGlobalPlayerStats.TryGetStat"/>
bool TryGetStat(Player player, StatCode<int> statCode, PersistInterval interval, out int value);
/// <inheritdoc cref="IGlobalPlayerStats.TryGetStat"/>
bool TryGetStat(Player player, StatCode<long> statCode, PersistInterval interval, out long value);
/// <inheritdoc cref="IGlobalPlayerStats.TryGetStat"/>
bool TryGetStat(Player player, StatCode<uint> statCode, PersistInterval interval, out uint value);
/// <inheritdoc cref="IGlobalPlayerStats.TryGetStat"/>
bool TryGetStat(Player player, StatCode<ulong> statCode, PersistInterval interval, out ulong value);
/// <inheritdoc cref="IGlobalPlayerStats.TryGetStat"/>
bool TryGetStat(Player player, StatCode<DateTime> statCode, PersistInterval interval, out DateTime value);
/// <inheritdoc cref="IGlobalPlayerStats.TryGetStat"/>
bool TryGetStat(Player player, StatCode<TimeSpan> statCode, PersistInterval interval, out TimeSpan value);
#endregion
#region Timer (TimeSpan stat) methods
/// <inheritdoc cref="IGlobalPlayerStats.StartTimer"/>
void StartTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
/// <inheritdoc cref="IGlobalPlayerStats.StopTimer"/>
void StopTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
/// <inheritdoc cref="IGlobalPlayerStats.ResetTimer"/>
void ResetTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
#endregion
}
/// <summary>
/// Interface for managing statistics on players that affects both global (zone-wide) and current arena stats.
/// </summary>
public interface IAllPlayerStats : IComponentInterface
{
#region IncrementStat methods
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<int> statCode, PersistInterval? interval, int amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<long> statCode, PersistInterval? interval, long amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<uint> statCode, PersistInterval? interval, uint amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<ulong> statCode, PersistInterval? interval, ulong amount);
/// <inheritdoc cref="IGlobalPlayerStats.IncrementStat"/>
void IncrementStat(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval, TimeSpan amount);
#endregion
#region SetStat methods
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<int> statCode, PersistInterval interval, int value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<long> statCode, PersistInterval interval, long value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<uint> statCode, PersistInterval interval, uint value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<ulong> statCode, PersistInterval interval, ulong value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<DateTime> statCode, PersistInterval interval, DateTime value);
/// <inheritdoc cref="IGlobalPlayerStats.SetStat"/>
void SetStat(Player player, StatCode<TimeSpan> statCode, PersistInterval interval, TimeSpan value);
#endregion
// No Get methods on purpose. Wouldn't know which stat to get, the global one or the current arena's.
#region Timer (TimeSpan stat) methods
/// <inheritdoc cref="IGlobalPlayerStats.StartTimer"/>
void StartTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
/// <inheritdoc cref="IGlobalPlayerStats.StopTimer"/>
void StopTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
/// <inheritdoc cref="IGlobalPlayerStats.ResetTimer"/>
void ResetTimer(Player player, StatCode<TimeSpan> statCode, PersistInterval? interval);
#endregion
}
/// <summary>
/// Interface for managing standard Subspace player stats (i.e., points, flag points, kills, deaths).
/// </summary>
public interface IScoreStats : IComponentInterface
{
/// <summary>
/// Gets scores for a player based on the player's current arena.
/// </summary>
/// <param name="player">The player to get score stats for.</param>
/// <param name="killPoints">The # of points the player has from kills.</param>
/// <param name="flagPoints">The # of points the player has from flags.</param>
/// <param name="kills">The # of kills the player has.</param>
/// <param name="deaths">The # of deaths the player has.</param>
void GetScores(Player player, out int killPoints, out int flagPoints, out ushort kills, out ushort deaths);
/// <summary>
/// Looks for players with dirty score stats (basic score stats only, i.e., kill points, flag points, kills, deaths).
/// <para>
/// For players that have dirty stats:
/// the stat is set as no longer dirty,
/// the score data is copied to the <see cref="Player.Packet"/>,
/// and a <see cref="Packets.Game.S2C_ScoreUpdate"/> packet is sent.
/// </para>
/// </summary>
/// <param name="arena">The arena to send updates for. <see langword="null"/> for all arenas.</param>
/// <param name="exclude">An optional player to exlude from both the check and any packet send.</param>
void SendUpdates(Arena? arena, Player? exclude);
/// <summary>
/// Resets all stats of a <paramref name="player"/> for an <paramref name="interval"/>.
/// </summary>
/// <remarks>
/// When resetting <see cref="PersistInterval.Reset"/>, a <see cref="Packets.Game.S2CPacketType.ScoreReset"/> packet is sent to the arena.
/// </remarks>
/// <param name="player">The player to reset the stats of.</param>
/// <param name="interval">The interval to reset stats for.</param>
void ScoreReset(Player player, PersistInterval interval);
/// <summary>
/// Resets all stats of all players in an <paramref name="arena"/> for an <paramref name="interval"/>.
/// </summary>
/// <remarks>
/// When resetting <see cref="PersistInterval.Reset"/>, a <see cref="Packets.Game.S2CPacketType.ScoreReset"/> packet is sent to the arena.
/// </remarks>
/// <param name="arena">The arena to reset the stats of.</param>
/// <param name="interval">The interval to reset stats for.</param>
void ScoreReset(Arena arena, PersistInterval interval);
}
}