Table of Contents

Class Kit

Namespace
Uncreated.Warfare.Kits
Assembly
Uncreated.Warfare.dll
public class Kit : IRequestable<Kit>, ITranslationArgument
Inheritance
Kit
Implements
Inherited Members
Extension Methods

Fields

FormatClass 

public static readonly SpecialFormat FormatClass

Field Value

SpecialFormat

FormatDisplayName 

public static readonly SpecialFormat FormatDisplayName

Field Value

SpecialFormat

FormatId 

public static readonly SpecialFormat FormatId

Field Value

SpecialFormat

Properties

Access

List of all players who have specific access to the kit.

public KitAccessRow[] Access { get; }

Property Value

KitAccessRow[]

Exceptions

NotIncludedException

Branch

The branch of the military the kit is a part of.

public Branch Branch { get; }

Property Value

Branch

Bundles

List of all elite bundles containing this kit. Non-elite kits will always return an empty array.

public EliteBundle[] Bundles { get; }

Property Value

EliteBundle[]

Exceptions

NotIncludedException

Class

The class of the kit, influencing its behavior in-game.

public Class Class { get; }

Property Value

Class

CreatedTimestamp

Time at which the kit was created.

public DateTimeOffset CreatedTimestamp { get; }

Property Value

DateTimeOffset

CreatingPlayer

The player who created the kit.

public CSteamID CreatingPlayer { get; }

Property Value

CSteamID

CreditCost

Cost to unlock this kit in in-game credits.

public int CreditCost { get; }

Property Value

int

Delays

List of all delays applied to the kit.

public ILayoutDelay<LayoutDelayContext>[] Delays { get; }

Property Value

ILayoutDelay<LayoutDelayContext>[]

Exceptions

NotIncludedException

Faction

Faction of the kit.

public FactionInfo Faction { get; }

Property Value

FactionInfo

FactionFilter

List of all factions in the blacklist or whitelist (depending on FactionFilterIsWhitelist).

public FactionInfo[] FactionFilter { get; }

Property Value

FactionInfo[]

Exceptions

NotIncludedException

FactionFilterIsWhitelist

If the faction filter acts as a whitelist instead of a blacklist.

public bool FactionFilterIsWhitelist { get; }

Property Value

bool

Favorites

List of all players who have favorited this kit.

public CSteamID[] Favorites { get; }

Property Value

CSteamID[]

Exceptions

NotIncludedException

Id

Internal name of the kit.

public string Id { get; }

Property Value

string

IsLocked

If the kit has been disabled.

public bool IsLocked { get; }

Property Value

bool

Remarks

This also indicates that a loadout is locked while it's undergoing creation or maintenance.

IsPaid 

public bool IsPaid { get; }

Property Value

bool

Items

List of all items in the kit.

public IKitItem[] Items { get; }

Property Value

IKitItem[]

Exceptions

NotIncludedException

Key

Primary key of the kit in the database.

public uint Key { get; }

Property Value

uint

LastEditedTimestamp

Time at which the kit was last updated.

public DateTimeOffset LastEditedTimestamp { get; }

Property Value

DateTimeOffset

LastEditingPlayer

The player who last edited the kit.

public CSteamID LastEditingPlayer { get; }

Property Value

CSteamID

MapFilter

List of all map IDs in the blacklist or whitelist (depending on MapFilterIsWhitelist).

public uint[] MapFilter { get; }

Property Value

uint[]

Exceptions

NotIncludedException

MapFilterIsWhitelist

If the map filter acts as a whitelist instead of a blacklist.

public bool MapFilterIsWhitelist { get; }

Property Value

bool

MinRequiredSquadMembers

A player can only use this kit after this many players are in their squad.

public int? MinRequiredSquadMembers { get; }

Property Value

int?

PremiumCost

Cost to unlock this kit in US dollars.

public decimal PremiumCost { get; }

Property Value

decimal

RequestCooldown

The individual cooldown between requests for this kit.

public TimeSpan RequestCooldown { get; }

Property Value

TimeSpan

RequiresServerBoost

If the kit requires the requester to be boosting the server with Discord Nitro.

public bool RequiresServerBoost { get; }

Property Value

bool

RequiresSquad

Whether a player needs to be in a squad in order to use this kit.

public bool RequiresSquad { get; }

Property Value

bool

Season

The season number the kit was created for.

public int Season { get; }

Property Value

int

Skillsets

List of all skillsets awarded to the player when they equip the kit.

public Skillset[] Skillsets { get; }

Property Value

Skillset[]

Exceptions

NotIncludedException

SquadLevel

Squad standing of the users of this kit.

public SquadLevel SquadLevel { get; }

Property Value

SquadLevel

Translations

Translation lookup table for the kit name.

public TranslationList Translations { get; }

Property Value

TranslationList

Exceptions

NotIncludedException

Type

The type of this kit, differentiating loadouts, elite kits, public kits, and other kits.

public KitType Type { get; }

Property Value

KitType

UnlockRequirements

List of all requirements to unlock the kit.

public UnlockRequirement[] UnlockRequirements { get; }

Property Value

UnlockRequirement[]

Exceptions

NotIncludedException

WeaponText

Text displayed on signs describing the weapons in the kit.

public string? WeaponText { get; }

Property Value

string

Methods

GetDisplayName(LanguageInfo?, bool, bool) 

public string GetDisplayName(LanguageInfo? language, bool useIdFallback, bool removeNewLine = true)

Parameters

language LanguageInfo
useIdFallback bool
removeNewLine bool

Returns

string
Edit this page