Class MySqlPointsStore

Namespace

Uncreated.Warfare.Stats

Assembly

Uncreated.Warfare.dll

Handles storing and loading player's points and reputation from a MySQL database.

public class MySqlPointsStore : IPointsStore

Inheritance

object

MySqlPointsStore

Implements

IPointsStore

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MySqlPointsStore(IManualMySqlProvider, IPlayerService)

public MySqlPointsStore(IManualMySqlProvider sql, IPlayerService playerService)

Parameters

sql IManualMySqlProvider

playerService IPlayerService

Fields

ColumnPointsCredits

public const string ColumnPointsCredits = "Credits"

Field Value

string

ColumnPointsFaction

public const string ColumnPointsFaction = "Faction"

Field Value

string

ColumnPointsSeason

public const string ColumnPointsSeason = "Season"

Field Value

string

ColumnPointsSteam64

public const string ColumnPointsSteam64 = "Steam64"

Field Value

string

ColumnPointsXP

public const string ColumnPointsXP = "XP"

Field Value

string

ColumnReputationSteam64

public const string ColumnReputationSteam64 = "Steam64"

Field Value

string

ColumnReputationValue

public const string ColumnReputationValue = "Reputation"

Field Value

string

MaxCredits

public const double MaxCredits = 1000

Field Value

double

TablePoints

public const string TablePoints = "user_points"

Field Value

string

TableReputation

public const string TableReputation = "user_reputation"

Field Value

string

Methods

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

Adds to credits for a player. Can be negative.

public 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, int, double, double, CancellationToken)

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

public 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.

public 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, int, double, CancellationToken)

Adds to XP for a player. Can be negative.

public 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.

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

Parameters

player CSteamID

factionId uint

season int

token CancellationToken

Returns

Task<double>

GetPointsAsync(CSteamID, uint, int, CancellationToken)

Queries both XP and credits for a player.

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

Parameters

player CSteamID

factionId uint

season int

token CancellationToken

Returns

Task<PlayerPoints>

GetReputationAsync(CSteamID, CancellationToken)

Queries reputation for a player.

public 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.

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

Parameters

player CSteamID

factionId uint

season int

token CancellationToken

Returns

Task<double>

OnPointsCacheable(CSteamID, uint, double?, double?, double?)

protected virtual void OnPointsCacheable(CSteamID player, uint factionId, double? xp, double? creds, double? rep)

Parameters

player CSteamID

factionId uint

xp double?

creds double?

rep double?

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

Directly sets the credits of a player.

public 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, int, double, double, CancellationToken)

Directly sets the credits and XP of a player.

public 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.

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

Parameters

player CSteamID

reputation double

token CancellationToken

Returns

Task

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

Directly sets the XP of a player.

public 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, int, double, CancellationToken)

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

public 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, int, double, double, CancellationToken)

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

public 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, int, double, CancellationToken)

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

public 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.