Class Squad

Namespace

Uncreated.Warfare.Squads

Assembly

Uncreated.Warfare.dll

public class Squad : ITranslationArgument

Inheritance

object

Squad

Implements

ITranslationArgument

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, ICommandUser, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, LanguageInfo?, CultureInfo?, TimeZoneInfo?, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, WarfarePlayer, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, in LanguageSet, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, ArgumentFormat, bool, TranslationOptions)

Fields

FormatColorName

public static readonly SpecialFormat FormatColorName

Field Value

SpecialFormat

FormatName

public static readonly SpecialFormat FormatName

Field Value

SpecialFormat

MaxMembers

public const int MaxMembers = 6

Field Value

int

Properties

IsFull

public bool IsFull { get; }

Property Value

bool

IsLocked

public bool IsLocked { get; }

Property Value

bool

Leader

public WarfarePlayer Leader { get; }

Property Value

WarfarePlayer

Members

public IReadOnlyList<WarfarePlayer> Members { get; }

Property Value

IReadOnlyList<WarfarePlayer>

Name

public string Name { get; }

Property Value

string

Team

public Team Team { get; }

Property Value

Team

TeamIdentificationNumber

A number starting at 1 that uniquely identifies the squad among the squads of a specific team.

public byte TeamIdentificationNumber { get; }

Property Value

byte

Methods

AddMember(WarfarePlayer)

public bool AddMember(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

CanJoinSquad(WarfarePlayer)

public bool CanJoinSquad(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

ContainsPlayer(WarfarePlayer)

public bool ContainsPlayer(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

Disband()

public bool Disband()

Returns

bool

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetMemberList()

public ulong[] GetMemberList()

Returns

ulong[]

IsLeader(WarfarePlayer)

public bool IsLeader(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

LockSquad(WarfarePlayer?)

public bool LockSquad(WarfarePlayer? instigator)

Parameters

instigator WarfarePlayer

Returns

bool

PromoteMember(WarfarePlayer)

public void PromoteMember(WarfarePlayer member)

Parameters

member WarfarePlayer

RemoveMember(WarfarePlayer)

public bool RemoveMember(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

TryAddMember(WarfarePlayer)

public bool TryAddMember(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

bool

UnlockSquad(WarfarePlayer?)

public bool UnlockSquad(WarfarePlayer? instigator)

Parameters

instigator WarfarePlayer

Returns

bool