Class UnlockRequirement

Namespace

Uncreated.Warfare.Players.Unlocks

Assembly

Uncreated.Warfare.dll

Generic read-only requirement to unlock something.

public abstract class UnlockRequirement : ICloneable

Inheritance

object

UnlockRequirement

Implements

ICloneable

Derived

LevelUnlockRequirement

QuestUnlockRequirement

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

PrimaryKey

public uint PrimaryKey { get; set; }

Property Value

uint

Methods

CanAccessAsync(WarfarePlayer, CancellationToken)

Full check if a player passes the requirements.

public virtual UniTask<bool> CanAccessAsync(WarfarePlayer player, CancellationToken token = default)

Parameters

player WarfarePlayer

token CancellationToken

Returns

UniTask<bool>

CanAccessFast(WarfarePlayer)

If a player passes the requirements. This check can do some caching, mainly for signs.

public abstract bool CanAccessFast(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

Clone()

Creates a new object that is a copy of the current instance.

public abstract object Clone()

Returns

object

A new object that is a copy of this instance.

GetSignText(WarfarePlayer?, LanguageInfo, CultureInfo)

Get the text that shows on a sign when the player is missing the requirement.

public abstract string GetSignText(WarfarePlayer? player, LanguageInfo language, CultureInfo culture)

Parameters

player WarfarePlayer

language LanguageInfo

culture CultureInfo

Returns

string

Initialize(IServiceProvider)

Initialize required services.

public virtual void Initialize(IServiceProvider serviceProvider)

Parameters

serviceProvider IServiceProvider

ReadLegacyProperty(ILogger?, ref Utf8JsonReader, string)

protected virtual void ReadLegacyProperty(ILogger? logger, ref Utf8JsonReader reader, string property)

Parameters

logger ILogger

reader Utf8JsonReader

property string

RequestKitFailureToMeet(CommandContext, Kit)

public virtual Exception RequestKitFailureToMeet(CommandContext ctx, Kit kit)

Parameters

ctx CommandContext

kit Kit

Returns

Exception

RequestVehicleFailureToMeet(CommandContext, WarfareVehicleInfo)

public virtual Exception RequestVehicleFailureToMeet(CommandContext ctx, WarfareVehicleInfo data)

Parameters

ctx CommandContext

data WarfareVehicleInfo

Returns

Exception