Class ColumnFormation

Namespace

TaleWorlds.MountAndBlade

Assembly

TaleWorlds.MountAndBlade.dll

public class ColumnFormation : IFormationArrangement

Inheritance

object

ColumnFormation

Implements

IFormationArrangement

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MBExtensions.GetGlobalHeadDirection(ColumnFormation)

MBExtensions.GetGlobalOrganicDirection(ColumnFormation)

Constructors

ColumnFormation(IFormation, IFormationUnit, int)

public ColumnFormation(IFormation ownerFormation, IFormationUnit vanguard = null, int columnCount = 1)

Parameters

ownerFormation IFormation

vanguard IFormationUnit

columnCount int

Fields

ArrangementAspectRatio

public static readonly int ArrangementAspectRatio

Field Value

int

Properties

ColumnCount

public int ColumnCount { get; set; }

Property Value

int

Depth

public float Depth { get; }

Property Value

float

Distance

protected float Distance { get; }

Property Value

float

FileCount

protected int FileCount { get; }

Property Value

int

FlankWidth

public float FlankWidth { get; set; }

Property Value

float

Interval

protected float Interval { get; }

Property Value

float

IsLoose

public bool? IsLoose { get; }

Property Value

bool?

MaximumWidth

public float MaximumWidth { get; }

Property Value

float

MinimumFlankWidth

public float MinimumFlankWidth { get; }

Property Value

float

MinimumWidth

public float MinimumWidth { get; }

Property Value

float

PositionedUnitCount

public int PositionedUnitCount { get; }

Property Value

int

RankCount

public int RankCount { get; }

Property Value

int

RankDepth

public float RankDepth { get; }

Property Value

float

UnitCount

public int UnitCount { get; }

Property Value

int

Vanguard

public IFormationUnit Vanguard { get; }

Property Value

IFormationUnit

Width

public float Width { get; set; }

Property Value

float

Methods

AddUnit(IFormationUnit)

public bool AddUnit(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

bool

BeforeFormationFrameChange()

public void BeforeFormationFrameChange()

Clone(IFormation)

public IFormationArrangement Clone(IFormation formation)

Parameters

formation IFormation

Returns

IFormationArrangement

CreateNewPosition(int)

public Vec2? CreateNewPosition(int unitIndex)

Parameters

unitIndex int

Returns

Vec2?

DeepCopyFrom(IFormationArrangement)

public void DeepCopyFrom(IFormationArrangement arrangement)

Parameters

arrangement IFormationArrangement

FormFromWidth(float)

public void FormFromWidth(float width)

Parameters

width float

GetAllUnits()

public MBReadOnlyList<IFormationUnit> GetAllUnits()

Returns

MBReadOnlyList<IFormationUnit>

GetDirectionChangeTendencyOfUnit(IFormationUnit)

public float GetDirectionChangeTendencyOfUnit(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

float

GetLocalDirectionOfRelativeFormationLocation(IFormationUnit)

public Vec2? GetLocalDirectionOfRelativeFormationLocation(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

Vec2?

GetLocalDirectionOfUnitOrDefault(int)

public Vec2? GetLocalDirectionOfUnitOrDefault(int unitIndex)

Parameters

unitIndex int

Returns

Vec2?

GetLocalDirectionOfUnitOrDefault(IFormationUnit)

public Vec2? GetLocalDirectionOfUnitOrDefault(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

Vec2?

GetLocalPositionOfReservedUnitPosition()

public Vec2 GetLocalPositionOfReservedUnitPosition()

Returns

Vec2

GetLocalPositionOfUnitOrDefault(int)

public Vec2? GetLocalPositionOfUnitOrDefault(int unitIndex)

Parameters

unitIndex int

Returns

Vec2?

GetLocalPositionOfUnitOrDefault(IFormationUnit)

public Vec2? GetLocalPositionOfUnitOrDefault(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

Vec2?

GetLocalPositionOfUnitOrDefaultWithAdjustment(IFormationUnit, float)

public Vec2? GetLocalPositionOfUnitOrDefaultWithAdjustment(IFormationUnit unit, float distanceBetweenAgentsAdjustment)

Parameters

unit IFormationUnit

distanceBetweenAgentsAdjustment float

Returns

Vec2?

GetLocalWallDirectionOfRelativeFormationLocation(IFormationUnit)

public Vec2? GetLocalWallDirectionOfRelativeFormationLocation(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

Vec2?

GetNeighborUnitOfLeftSide(IFormationUnit)

public IFormationUnit GetNeighborUnitOfLeftSide(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

IFormationUnit

GetNeighborUnitOfRightSide(IFormationUnit)

public IFormationUnit GetNeighborUnitOfRightSide(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

IFormationUnit

GetOccupationWidth(int)

public float GetOccupationWidth(int unitCount)

Parameters

unitCount int

Returns

float

GetPlayerUnit()

public IFormationUnit GetPlayerUnit()

Returns

IFormationUnit

GetUnavailableUnitPositions()

public IEnumerable<Vec2> GetUnavailableUnitPositions()

Returns

IEnumerable<Vec2>

GetUnit(int, int)

public IFormationUnit GetUnit(int fileIndex, int rankIndex)

Parameters

fileIndex int

rankIndex int

Returns

IFormationUnit

GetUnitCountWithOverride()

protected int GetUnitCountWithOverride()

Returns

int

GetUnitsAtVanguardFile<T>()

public IEnumerable<T> GetUnitsAtVanguardFile<T>() where T : IFormationUnit

Returns

IEnumerable<T>

Type Parameters

T

GetUnitsDistanceToFrontLine(IFormationUnit)

public float GetUnitsDistanceToFrontLine(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

float

GetUnitsToPop(int)

public List<IFormationUnit> GetUnitsToPop(int count)

Parameters

count int

Returns

List<IFormationUnit>

GetUnitsToPop(int, Vec3)

public List<IFormationUnit> GetUnitsToPop(int count, Vec3 targetPosition)

Parameters

count int

targetPosition Vec3

Returns

List<IFormationUnit>

GetUnitsToPopWithCondition(int, Func<IFormationUnit, bool>)

public IEnumerable<IFormationUnit> GetUnitsToPopWithCondition(int count, Func<IFormationUnit, bool> currentCondition)

Parameters

count int

currentCondition Func<IFormationUnit, bool>

Returns

IEnumerable<IFormationUnit>

GetUnpositionedUnits()

public MBList<IFormationUnit> GetUnpositionedUnits()

Returns

MBList<IFormationUnit>

GetWorldPositionOfUnitOrDefault(int)

public WorldPosition? GetWorldPositionOfUnitOrDefault(int unitIndex)

Parameters

unitIndex int

Returns

WorldPosition?

GetWorldPositionOfUnitOrDefault(IFormationUnit)

public WorldPosition? GetWorldPositionOfUnitOrDefault(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

WorldPosition?

InvalidateCacheOfUnitAux(Vec2)

public void InvalidateCacheOfUnitAux(Vec2 roundedLocalPosition)

Parameters

roundedLocalPosition Vec2

IsTurnBackwardsNecessary(Vec2, WorldPosition?, Vec2, bool, Vec2?)

public bool IsTurnBackwardsNecessary(Vec2 previousPosition, WorldPosition? newPosition, Vec2 previousDirection, bool hasNewDirection, Vec2? newDirection)

Parameters

previousPosition Vec2

newPosition WorldPosition?

previousDirection Vec2

hasNewDirection bool

newDirection Vec2?

Returns

bool

OnBatchRemoveEnd()

public void OnBatchRemoveEnd()

OnBatchRemoveStart()

public void OnBatchRemoveStart()

OnFormationDispersed()

public void OnFormationDispersed()

OnFormationFrameChanged()

public void OnFormationFrameChanged()

OnTickOccasionallyOfUnit(IFormationUnit, bool)

public void OnTickOccasionallyOfUnit(IFormationUnit unit, bool arrangementChangeAllowed)

Parameters

unit IFormationUnit

arrangementChangeAllowed bool

OnUnitLostMount(IFormationUnit)

public void OnUnitLostMount(IFormationUnit unit)

Parameters

unit IFormationUnit

RearrangeFrom(IFormationArrangement)

public virtual void RearrangeFrom(IFormationArrangement arrangement)

Parameters

arrangement IFormationArrangement

RearrangeTo(IFormationArrangement)

public virtual void RearrangeTo(IFormationArrangement arrangement)

Parameters

arrangement IFormationArrangement

RearrangeTransferUnits(IFormationArrangement)

public virtual void RearrangeTransferUnits(IFormationArrangement arrangement)

Parameters

arrangement IFormationArrangement

ReleaseMiddleFrontUnitPosition()

public void ReleaseMiddleFrontUnitPosition()

RemoveUnit(IFormationUnit)

public void RemoveUnit(IFormationUnit unit)

Parameters

unit IFormationUnit

ReserveMiddleFrontUnitPosition(IFormationUnit)

public void ReserveMiddleFrontUnitPosition(IFormationUnit vanguard)

Parameters

vanguard IFormationUnit

Reset()

public void Reset()

SwitchUnitLocations(IFormationUnit, IFormationUnit)

public void SwitchUnitLocations(IFormationUnit firstUnit, IFormationUnit secondUnit)

Parameters

firstUnit IFormationUnit

secondUnit IFormationUnit

SwitchUnitLocationsWithBackMostUnit(IFormationUnit)

public void SwitchUnitLocationsWithBackMostUnit(IFormationUnit unit)

Parameters

unit IFormationUnit

SwitchUnitLocationsWithUnpositionedUnit(IFormationUnit, IFormationUnit)

public void SwitchUnitLocationsWithUnpositionedUnit(IFormationUnit firstUnit, IFormationUnit secondUnit)

Parameters

firstUnit IFormationUnit

secondUnit IFormationUnit

TurnBackwards()

public void TurnBackwards()

Events

OnShapeChanged

public event Action OnShapeChanged

Event Type

Action

OnWidthChanged

public event Action OnWidthChanged

Event Type

Action

---

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).