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
|
using System;
using System.Collections.Generic;
using System.Linq;
#if SMAPI_DEPRECATED
using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Deprecations;
#endif
namespace StardewModdingAPI.Utilities
{
/// <summary>Manages a separate value for each player in split-screen mode. This can safely be used in non-split-screen mode too, it'll just have a single state in that case.</summary>
/// <typeparam name="T">The state class.</typeparam>
public class PerScreen<T>
{
/*********
** Fields
*********/
/// <summary>Create the initial value for a screen.</summary>
private readonly Func<T> CreateNewState;
/// <summary>The tracked values for each screen.</summary>
private readonly IDictionary<int, T> States = new Dictionary<int, T>();
/// <summary>The last <see cref="Context.LastRemovedScreenId"/> value for which this instance was updated.</summary>
private int LastRemovedScreenId;
/*********
** Accessors
*********/
/// <summary>The value for the current screen.</summary>
/// <remarks>The value is initialized the first time it's requested for that screen, unless it's set manually first.</remarks>
public T Value
{
get => this.GetValueForScreen(Context.ScreenId);
set => this.SetValueForScreen(Context.ScreenId, value);
}
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <remarks><strong>Limitation with nullable reference types:</strong> when the underlying type <typeparamref name="T"/> is nullable, this sets the default value to null regardless of whether you marked the type parameter nullable. To avoid that, set the default value with the 'createNewState' argument instead.</remarks>
public PerScreen()
{
this.CreateNewState = (() => default!);
}
/// <summary>Construct an instance.</summary>
/// <param name="createNewState">Create the initial state for a screen.</param>
public PerScreen(Func<T> createNewState)
{
if (createNewState is null)
{
#if SMAPI_DEPRECATED
createNewState = (() => default!);
SCore.DeprecationManager.Warn(
null,
$"calling the {nameof(PerScreen<T>)} constructor with null",
"3.14.0",
DeprecationLevel.PendingRemoval
);
#else
throw new ArgumentNullException(nameof(createNewState));
#endif
}
this.CreateNewState = createNewState;
}
/// <summary>Get all active values by screen ID. This doesn't initialize the value for a screen ID if it's not created yet.</summary>
public IEnumerable<KeyValuePair<int, T>> GetActiveValues()
{
this.RemoveDeadScreens();
return this.States.ToArray();
}
/// <summary>Get the value for a given screen ID, creating it if needed.</summary>
/// <param name="screenId">The screen ID to check.</param>
public T GetValueForScreen(int screenId)
{
this.RemoveDeadScreens();
return this.States.TryGetValue(screenId, out T? state)
? state
: this.States[screenId] = this.CreateNewState();
}
/// <summary>Set the value for a given screen ID.</summary>
/// <param name="screenId">The screen ID whose value set.</param>
/// <param name="value">The value to set.</param>
public void SetValueForScreen(int screenId, T value)
{
this.RemoveDeadScreens();
this.States[screenId] = value;
}
/// <summary>Remove all active values.</summary>
public void ResetAllScreens()
{
this.RemoveScreens(_ => true);
}
/*********
** Private methods
*********/
/// <summary>Remove screens which are no longer active.</summary>
private void RemoveDeadScreens()
{
if (this.LastRemovedScreenId == Context.LastRemovedScreenId)
return;
this.LastRemovedScreenId = Context.LastRemovedScreenId;
this.RemoveScreens(id => !Context.HasScreenId(id));
}
/// <summary>Remove screens matching a condition.</summary>
/// <param name="shouldRemove">Returns whether a screen ID should be removed.</param>
private void RemoveScreens(Func<int, bool> shouldRemove)
{
foreach (var pair in this.States.ToArray())
{
if (shouldRemove(pair.Key))
this.States.Remove(pair.Key);
}
}
}
}
|
