Table of Contents

Class SquareFormation

Namespace
TaleWorlds.MountAndBlade
Assembly
TaleWorlds.MountAndBlade.dll
public class SquareFormation : LineFormation, IFormationArrangement
Inheritance
SquareFormation
Implements
Derived
Inherited Members

Constructors

SquareFormation(IFormation)

public SquareFormation(IFormation owner)

Parameters

owner IFormation

Properties

Depth

public override float Depth { get; }

Property Value

float

MaximumWidth

public override float MaximumWidth { get; }

Property Value

float

MinimumWidth

public override float MinimumWidth { get; }

Property Value

float

Width

public override float Width { get; set; }

Property Value

float

Methods

Clone(IFormation)

public override IFormationArrangement Clone(IFormation formation)

Parameters

formation IFormation

Returns

IFormationArrangement

DeepCopyFrom(IFormationArrangement)

public override void DeepCopyFrom(IFormationArrangement arrangement)

Parameters

arrangement IFormationArrangement

FormFromBorderSideWidth(float)

public void FormFromBorderSideWidth(float borderSideWidth)

Parameters

borderSideWidth float

FormFromBorderUnitCountPerSide(int)

public void FormFromBorderUnitCountPerSide(int unitCountPerSide)

Parameters

unitCountPerSide int

FormFromRankCount(int)

public void FormFromRankCount(int rankCount)

Parameters

rankCount int

GetLocalDirectionOfUnit(int, int)

protected override Vec2 GetLocalDirectionOfUnit(int fileIndex, int rankIndex)

Parameters

fileIndex int
rankIndex int

Returns

Vec2

GetLocalDirectionOfUnitOrDefault(IFormationUnit)

public override Vec2? GetLocalDirectionOfUnitOrDefault(IFormationUnit unit)

Parameters

unit IFormationUnit

Returns

Vec2?

GetLocalPositionOfUnit(int, int)

protected override Vec2 GetLocalPositionOfUnit(int fileIndex, int rankIndex)

Parameters

fileIndex int
rankIndex int

Returns

Vec2

GetLocalPositionOfUnitWithAdjustment(int, int, float)

protected override Vec2 GetLocalPositionOfUnitWithAdjustment(int fileIndex, int rankIndex, float distanceBetweenAgentsAdjustment)

Parameters

fileIndex int
rankIndex int
distanceBetweenAgentsAdjustment float

Returns

Vec2

GetMaximumRankCount(int, out int)

protected static int GetMaximumRankCount(int unitCount, out int minimumFlankCount)

Parameters

unitCount int
minimumFlankCount int

Returns

int

GetSideWidthFromUnitCount(int, float, float)

protected static float GetSideWidthFromUnitCount(int sideUnitCount, float interval, float unitDiameter)

Parameters

sideUnitCount int
interval float
unitDiameter float

Returns

float

GetUnitsPerSideFromRankCount(int)

public int GetUnitsPerSideFromRankCount(int rankCount)

Parameters

rankCount int

Returns

int

IsUnitPositionRestrained(int, int)

protected override bool IsUnitPositionRestrained(int fileIndex, int rankIndex)

Parameters

fileIndex int
rankIndex int

Returns

bool

MakeRestrainedPositionsUnavailable()

protected override void MakeRestrainedPositionsUnavailable()

TryGetUnitPositionIndexFromLocalPosition(Vec2, out int, out int)

protected override bool TryGetUnitPositionIndexFromLocalPosition(Vec2 localPosition, out int fileIndex, out int rankIndex)

Parameters

localPosition Vec2
fileIndex int
rankIndex int

Returns

bool

TurnBackwards()

public override void TurnBackwards()

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