Interface IPointsStore

Namespace

Uncreated.Warfare.Stats

Assembly

Uncreated.Warfare.dll

Handles storing and loading player's points and reputation.

public interface IPointsStore

Remarks

Contains operations for read, add/subtract, and set, including bulk operations for both XP and credits.

Methods

AddToCreditsAsync(CSteamID, uint, double, CancellationToken)

Adds to credits for a player. Can be negative.

Task<PlayerPoints> AddToCreditsAsync(CSteamID player, uint factionId, double deltaCredits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

deltaCredits double

token CancellationToken

Returns

Task<PlayerPoints>

The resulting point count.

AddToCreditsAsync(CSteamID, uint, int, double, CancellationToken)

Adds to credits for a player. Can be negative.

Task<PlayerPoints> AddToCreditsAsync(CSteamID player, uint factionId, int season, double deltaCredits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

deltaCredits double

token CancellationToken

Returns

Task<PlayerPoints>

The resulting point count.

AddToPointsAsync(CSteamID, uint, double, double, CancellationToken)

Adds to XP and credits for a player. Can be negative.

Task<PlayerPoints> AddToPointsAsync(CSteamID player, uint factionId, double deltaXp, double deltaCredits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

deltaXp double

deltaCredits double

token CancellationToken

Returns

Task<PlayerPoints>

The resulting point count.

AddToPointsAsync(CSteamID, uint, int, double, double, CancellationToken)

Adds to XP and credits for a player. Can be negative.

Task<PlayerPoints> AddToPointsAsync(CSteamID player, uint factionId, int season, double deltaXp, double deltaCredits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

deltaXp double

deltaCredits double

token CancellationToken

Returns

Task<PlayerPoints>

The resulting point count.

AddToReputationAsync(CSteamID, double, CancellationToken)

Adds to reputation for a player. Can be negative.

Task<double> AddToReputationAsync(CSteamID player, double deltaReputation, CancellationToken token = default)

Parameters

player CSteamID

deltaReputation double

token CancellationToken

Returns

Task<double>

The resulting reputation count.

AddToXPAsync(CSteamID, uint, double, CancellationToken)

Adds to XP for a player. Can be negative.

Task<PlayerPoints> AddToXPAsync(CSteamID player, uint factionId, double deltaXp, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

deltaXp double

token CancellationToken

Returns

Task<PlayerPoints>

The resulting point count.

AddToXPAsync(CSteamID, uint, int, double, CancellationToken)

Adds to XP for a player. Can be negative.

Task<PlayerPoints> AddToXPAsync(CSteamID player, uint factionId, int season, double deltaXp, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

deltaXp double

token CancellationToken

Returns

Task<PlayerPoints>

The resulting point count.

GetCreditsAsync(CSteamID, uint, int, CancellationToken)

Queries credits for a player.

Task<double> GetCreditsAsync(CSteamID player, uint factionId, int season, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

token CancellationToken

Returns

Task<double>

GetCreditsAsync(CSteamID, uint, CancellationToken)

Queries credits for a player.

Task<double> GetCreditsAsync(CSteamID player, uint factionId, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

token CancellationToken

Returns

Task<double>

GetPointsAsync(CSteamID, uint, int, CancellationToken)

Queries both XP and credits for a player.

Task<PlayerPoints> GetPointsAsync(CSteamID player, uint factionId, int season, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

token CancellationToken

Returns

Task<PlayerPoints>

GetPointsAsync(CSteamID, uint, CancellationToken)

Queries both XP and credits for a player.

Task<PlayerPoints> GetPointsAsync(CSteamID player, uint factionId, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

token CancellationToken

Returns

Task<PlayerPoints>

GetReputationAsync(CSteamID, CancellationToken)

Queries reputation for a player.

Task<double> GetReputationAsync(CSteamID player, CancellationToken token = default)

Parameters

player CSteamID

token CancellationToken

Returns

Task<double>

GetXPAsync(CSteamID, uint, int, CancellationToken)

Queries XP for a player.

Task<double> GetXPAsync(CSteamID player, uint factionId, int season, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

token CancellationToken

Returns

Task<double>

GetXPAsync(CSteamID, uint, CancellationToken)

Queries XP for a player.

Task<double> GetXPAsync(CSteamID player, uint factionId, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

token CancellationToken

Returns

Task<double>

SetCreditsAsync(CSteamID, uint, double, CancellationToken)

Directly sets the credits of a player.

Task SetCreditsAsync(CSteamID player, uint factionId, double credits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

credits double

token CancellationToken

Returns

Task

SetCreditsAsync(CSteamID, uint, int, double, CancellationToken)

Directly sets the credits of a player.

Task SetCreditsAsync(CSteamID player, uint factionId, int season, double credits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

credits double

token CancellationToken

Returns

Task

SetPointsAsync(CSteamID, uint, double, double, CancellationToken)

Directly sets the credits and XP of a player.

Task SetPointsAsync(CSteamID player, uint factionId, double xp, double credits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

xp double

credits double

token CancellationToken

Returns

Task

SetPointsAsync(CSteamID, uint, int, double, double, CancellationToken)

Directly sets the credits and XP of a player.

Task SetPointsAsync(CSteamID player, uint factionId, int season, double xp, double credits, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

xp double

credits double

token CancellationToken

Returns

Task

SetReputationAsync(CSteamID, double, CancellationToken)

Directly sets the reputation of a player.

Task SetReputationAsync(CSteamID player, double reputation, CancellationToken token = default)

Parameters

player CSteamID

reputation double

token CancellationToken

Returns

Task

SetXPAsync(CSteamID, uint, double, CancellationToken)

Directly sets the XP of a player.

Task SetXPAsync(CSteamID player, uint factionId, double xp, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

xp double

token CancellationToken

Returns

Task

SetXPAsync(CSteamID, uint, int, double, CancellationToken)

Directly sets the XP of a player.

Task SetXPAsync(CSteamID player, uint factionId, int season, double xp, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

xp double

token CancellationToken

Returns

Task

TryRemoveCredits(CSteamID, uint, double, CancellationToken)

Attempts to remove an amount of credits from a player only if they have enough to spare.

Task<bool> TryRemoveCredits(CSteamID player, uint factionId, double creditsToRemove, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

creditsToRemove double

token CancellationToken

Returns

Task<bool>

If the removal was successful.

TryRemoveCredits(CSteamID, uint, int, double, CancellationToken)

Attempts to remove an amount of credits from a player only if they have enough to spare.

Task<bool> TryRemoveCredits(CSteamID player, uint factionId, int season, double creditsToRemove, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

creditsToRemove double

token CancellationToken

Returns

Task<bool>

If the removal was successful.

TryRemovePoints(CSteamID, uint, double, double, CancellationToken)

Attempts to remove an amount of XP and credits from a player only if they have enough to spare.

Task<bool> TryRemovePoints(CSteamID player, uint factionId, double xpToRemove, double creditsToRemove, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

xpToRemove double

creditsToRemove double

token CancellationToken

Returns

Task<bool>

If the removal was successful.

TryRemovePoints(CSteamID, uint, int, double, double, CancellationToken)

Attempts to remove an amount of XP and credits from a player only if they have enough to spare.

Task<bool> TryRemovePoints(CSteamID player, uint factionId, int season, double xpToRemove, double creditsToRemove, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

xpToRemove double

creditsToRemove double

token CancellationToken

Returns

Task<bool>

If the removal was successful.

TryRemoveXP(CSteamID, uint, double, CancellationToken)

Attempts to remove an amount of XP from a player only if they have enough to spare.

Task<bool> TryRemoveXP(CSteamID player, uint factionId, double xpToRemove, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

xpToRemove double

token CancellationToken

Returns

Task<bool>

If the removal was successful.

TryRemoveXP(CSteamID, uint, int, double, CancellationToken)

Attempts to remove an amount of XP from a player only if they have enough to spare.

Task<bool> TryRemoveXP(CSteamID player, uint factionId, int season, double xpToRemove, CancellationToken token = default)

Parameters

player CSteamID

factionId uint

season int

xpToRemove double

token CancellationToken

Returns

Task<bool>

If the removal was successful.