Skip to content

#4: Deprecate empty ResourceStat constructor and introduce one to giv… #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
greenstack merged 1 commit into from
Feb 21, 2026
Merged

#4: Deprecate empty ResourceStat constructor and introduce one to giv… #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions src/Stats.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
* IN THE SOFTWARE.
*/

using System.Diagnostics.CodeAnalysis;
using System.Numerics;

namespace Greenstack.GameStats
Expand Down Expand Up @@ -276,16 +277,19 @@ public override int GetHashCode()

public T Max { get; set; } = T.MaxValue;

private T _currentValue;
private T _currentValue = T.Zero;

public event StatValueChanged<T>? OnStatChanged;

public required T CurrentValue
{
get => _currentValue;
[MemberNotNull(nameof(_currentValue))]
set
{
T oldValue = _currentValue;
// Supressing null here because the first time this is called,
// we're not going to have any event subscribers yet
T oldValue = _currentValue!;
_currentValue = T.Clamp(value, Min, Max);
if (_currentValue != oldValue)
{
Expand All @@ -301,16 +305,23 @@ public required T CurrentValue
/// </summary>
public bool IsDepleted => CurrentValue == Min;

#pragma warning disable 8618 // CurrentValue is a setter for _currentValue
/// <summary>
///
/// Empty constructor.
/// </summary>
/// <param name="currentValue"></param>
[Obsolete($"Use constructor that accepts a parameter for the MaxValue instead")]
public ResourceStat()
#pragma warning restore 8618
{
}

/// <summary>
/// Creates a resource stat with the maximum value set.
/// </summary>
/// <param name="maxValue">The maximum value for this resource.</param>
public ResourceStat(T maxValue)
{
Max = maxValue;
}

public void Increase(T amount)
{
CurrentValue += amount;
Expand Down
Loading