TaleWorlds.MountAndBlade.IFormationArrangement Interface Reference

Inherited by TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

Public Member Functions
IFormationUnit	GetPlayerUnit ()
MBList< IFormationUnit >	GetAllUnits ()
MBList< IFormationUnit >	GetUnpositionedUnits ()
bool	AddUnit (IFormationUnit unit)
	Adding may fail if there is no vacant position and deepening the formation does not create any new vacant positions.
void	RemoveUnit (IFormationUnit unit)
IFormationUnit	GetUnit (int fileIndex, int rankIndex)
	Returns the unit at the specified file and rank index Returns null if the specified position is restrained, is not valid or if there is no agent assigned to this position.
void	OnBatchRemoveStart ()
	Notifies the arrangement that remove operations will be done in batch for performance. Child arrangements should provide their own implementation.
void	OnBatchRemoveEnd ()
Vec2?	GetLocalPositionOfUnitOrDefault (int unitIndex)
Vec2?	GetLocalPositionOfUnitOrDefault (IFormationUnit unit)
Vec2?	GetLocalPositionOfUnitOrDefaultWithAdjustment (IFormationUnit unit, float distanceBetweenAgentsAdjustment)
Vec2?	GetLocalDirectionOfUnitOrDefault (int unitIndex)
Vec2?	GetLocalDirectionOfUnitOrDefault (IFormationUnit unit)
WorldPosition?	GetWorldPositionOfUnitOrDefault (int unitIndex)
WorldPosition?	GetWorldPositionOfUnitOrDefault (IFormationUnit unit)
List< IFormationUnit >	GetUnitsToPop (int count)
List< IFormationUnit >	GetUnitsToPop (int count, Vec3 targetPosition)
IEnumerable< IFormationUnit >	GetUnitsToPopWithCondition (int count, Func< IFormationUnit, bool > conditionFunction)
void	SwitchUnitLocations (IFormationUnit firstUnit, IFormationUnit secondUnit)
void	SwitchUnitLocationsWithUnpositionedUnit (IFormationUnit firstUnit, IFormationUnit secondUnit)
void	SwitchUnitLocationsWithBackMostUnit (IFormationUnit unit)
IFormationUnit	GetNeighborUnitOfLeftSide (IFormationUnit unit)
IFormationUnit	GetNeighborUnitOfRightSide (IFormationUnit unit)
Vec2?	GetLocalWallDirectionOfRelativeFormationLocation (IFormationUnit unit)
IEnumerable< Vec2 >	GetUnavailableUnitPositions ()
float	GetOccupationWidth (int unitCount)
Vec2?	CreateNewPosition (int unitIndex)
void	BeforeFormationFrameChange ()
void	OnFormationFrameChanged ()
bool	IsTurnBackwardsNecessary (Vec2 previousPosition, WorldPosition? newPosition, Vec2 previousDirection, bool hasNewDirection, Vec2? newDirection)
void	TurnBackwards ()
void	OnFormationDispersed ()
void	Reset ()
IFormationArrangement	Clone (IFormation formation)
void	DeepCopyFrom (IFormationArrangement arrangement)
void	RearrangeTo (IFormationArrangement arrangement)
void	RearrangeFrom (IFormationArrangement arrangement)
void	RearrangeTransferUnits (IFormationArrangement arrangement)
void	ReserveMiddleFrontUnitPosition (IFormationUnit vanguard)
void	ReleaseMiddleFrontUnitPosition ()
Vec2	GetLocalPositionOfReservedUnitPosition ()
void	OnTickOccasionallyOfUnit (IFormationUnit unit, bool arrangementChangeAllowed)
void	OnUnitLostMount (IFormationUnit unit)
float	GetDirectionChangeTendencyOfUnit (IFormationUnit unit)

Properties
float	Width [get, set]
	Actual space occupied by the formation along side (x) direction, measured from left to right.
float	Depth [get]
	Actual space occupied by the formation along forward (y) direction, from front to back.
float	FlankWidth [get, set]
	Space occupied from the formation's left most flank to right most flank REMARK_ATES: For rectangular formations this matches width. For circular formations (and alike) this matches circumference.
float	RankDepth [get]
	Space occupied from the formation's front rank to back most rank. REMARK_ATES: For rectangular formations this matches depth. For circular formations (and alike) this matches radius.
float	MinimumWidth [get]
	Minimum width of the formation. Using current unit count, minimum unit interval and minimum unit distance.
float	MaximumWidth [get]
	Maximum width of the formation. Using current unit count, maximum unit interval and maximum unit distance.
float	MinimumFlankWidth [get]
bool?	IsLoose [get]
int	UnitCount [get]
int	RankCount [get]
int	PositionedUnitCount [get]
bool	AreLocalPositionsDirty [set]

Events
Action	OnWidthChanged
Action	OnShapeChanged

Member Function Documentation

GetPlayerUnit()

IFormationUnit TaleWorlds.MountAndBlade.IFormationArrangement.GetPlayerUnit

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetAllUnits()

MBList< IFormationUnit > TaleWorlds.MountAndBlade.IFormationArrangement.GetAllUnits

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetUnpositionedUnits()

MBList< IFormationUnit > TaleWorlds.MountAndBlade.IFormationArrangement.GetUnpositionedUnits

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

AddUnit()

bool TaleWorlds.MountAndBlade.IFormationArrangement.AddUnit

(

IFormationUnit

unit

)

Parameters

unit

Returns

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

RemoveUnit()

void TaleWorlds.MountAndBlade.IFormationArrangement.RemoveUnit

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetUnit()

IFormationUnit TaleWorlds.MountAndBlade.IFormationArrangement.GetUnit	(	int	fileIndex,
		int	rankIndex
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

OnBatchRemoveStart()

void TaleWorlds.MountAndBlade.IFormationArrangement.OnBatchRemoveStart

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

OnBatchRemoveEnd()

void TaleWorlds.MountAndBlade.IFormationArrangement.OnBatchRemoveEnd

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalPositionOfUnitOrDefault() [1/2]

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalPositionOfUnitOrDefault

(

int

unitIndex

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalPositionOfUnitOrDefault() [2/2]

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalPositionOfUnitOrDefault

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalPositionOfUnitOrDefaultWithAdjustment()

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalPositionOfUnitOrDefaultWithAdjustment	(	IFormationUnit	unit,
		float	distanceBetweenAgentsAdjustment
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalDirectionOfUnitOrDefault() [1/2]

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalDirectionOfUnitOrDefault

(

int

unitIndex

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalDirectionOfUnitOrDefault() [2/2]

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalDirectionOfUnitOrDefault

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetWorldPositionOfUnitOrDefault() [1/2]

WorldPosition? TaleWorlds.MountAndBlade.IFormationArrangement.GetWorldPositionOfUnitOrDefault

(

int

unitIndex

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetWorldPositionOfUnitOrDefault() [2/2]

WorldPosition? TaleWorlds.MountAndBlade.IFormationArrangement.GetWorldPositionOfUnitOrDefault

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetUnitsToPop() [1/2]

List< IFormationUnit > TaleWorlds.MountAndBlade.IFormationArrangement.GetUnitsToPop

(

int

count

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetUnitsToPop() [2/2]

List< IFormationUnit > TaleWorlds.MountAndBlade.IFormationArrangement.GetUnitsToPop	(	int	count,
		Vec3	targetPosition
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetUnitsToPopWithCondition()

IEnumerable< IFormationUnit > TaleWorlds.MountAndBlade.IFormationArrangement.GetUnitsToPopWithCondition	(	int	count,
		Func< IFormationUnit, bool >	conditionFunction
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

SwitchUnitLocations()

void TaleWorlds.MountAndBlade.IFormationArrangement.SwitchUnitLocations	(	IFormationUnit	firstUnit,
		IFormationUnit	secondUnit
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

SwitchUnitLocationsWithUnpositionedUnit()

void TaleWorlds.MountAndBlade.IFormationArrangement.SwitchUnitLocationsWithUnpositionedUnit	(	IFormationUnit	firstUnit,
		IFormationUnit	secondUnit
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

SwitchUnitLocationsWithBackMostUnit()

void TaleWorlds.MountAndBlade.IFormationArrangement.SwitchUnitLocationsWithBackMostUnit

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetNeighborUnitOfLeftSide()

IFormationUnit TaleWorlds.MountAndBlade.IFormationArrangement.GetNeighborUnitOfLeftSide

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetNeighborUnitOfRightSide()

IFormationUnit TaleWorlds.MountAndBlade.IFormationArrangement.GetNeighborUnitOfRightSide

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalWallDirectionOfRelativeFormationLocation()

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalWallDirectionOfRelativeFormationLocation

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetUnavailableUnitPositions()

IEnumerable< Vec2 > TaleWorlds.MountAndBlade.IFormationArrangement.GetUnavailableUnitPositions

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetOccupationWidth()

float TaleWorlds.MountAndBlade.IFormationArrangement.GetOccupationWidth

(

int

unitCount

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

CreateNewPosition()

Vec2? TaleWorlds.MountAndBlade.IFormationArrangement.CreateNewPosition

(

int

unitIndex

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

BeforeFormationFrameChange()

void TaleWorlds.MountAndBlade.IFormationArrangement.BeforeFormationFrameChange

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

OnFormationFrameChanged()

void TaleWorlds.MountAndBlade.IFormationArrangement.OnFormationFrameChanged

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

IsTurnBackwardsNecessary()

bool TaleWorlds.MountAndBlade.IFormationArrangement.IsTurnBackwardsNecessary	(	Vec2	previousPosition,
		WorldPosition?	newPosition,
		Vec2	previousDirection,
		bool	hasNewDirection,
		Vec2?	newDirection
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

TurnBackwards()

void TaleWorlds.MountAndBlade.IFormationArrangement.TurnBackwards

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

OnFormationDispersed()

void TaleWorlds.MountAndBlade.IFormationArrangement.OnFormationDispersed

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

Reset()

void TaleWorlds.MountAndBlade.IFormationArrangement.Reset

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

Clone()

IFormationArrangement TaleWorlds.MountAndBlade.IFormationArrangement.Clone

(

IFormation

formation

)

Implemented in TaleWorlds.MountAndBlade.CircularFormation, TaleWorlds.MountAndBlade.CircularSchiltronFormation, TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, TaleWorlds.MountAndBlade.TransposedLineFormation, TaleWorlds.MountAndBlade.RectilinearSchiltronFormation, TaleWorlds.MountAndBlade.SkeinFormation, TaleWorlds.MountAndBlade.SquareFormation, and TaleWorlds.MountAndBlade.WedgeFormation.

DeepCopyFrom()

void TaleWorlds.MountAndBlade.IFormationArrangement.DeepCopyFrom

(

IFormationArrangement

arrangement

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, and TaleWorlds.MountAndBlade.SquareFormation.

RearrangeTo()

void TaleWorlds.MountAndBlade.IFormationArrangement.RearrangeTo

(

IFormationArrangement

arrangement

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

RearrangeFrom()

void TaleWorlds.MountAndBlade.IFormationArrangement.RearrangeFrom

(

IFormationArrangement

arrangement

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, and TaleWorlds.MountAndBlade.TransposedLineFormation.

RearrangeTransferUnits()

void TaleWorlds.MountAndBlade.IFormationArrangement.RearrangeTransferUnits

(

IFormationArrangement

arrangement

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

ReserveMiddleFrontUnitPosition()

void TaleWorlds.MountAndBlade.IFormationArrangement.ReserveMiddleFrontUnitPosition

(

IFormationUnit

vanguard

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

ReleaseMiddleFrontUnitPosition()

void TaleWorlds.MountAndBlade.IFormationArrangement.ReleaseMiddleFrontUnitPosition

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetLocalPositionOfReservedUnitPosition()

Vec2 TaleWorlds.MountAndBlade.IFormationArrangement.GetLocalPositionOfReservedUnitPosition

(

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

OnTickOccasionallyOfUnit()

void TaleWorlds.MountAndBlade.IFormationArrangement.OnTickOccasionallyOfUnit	(	IFormationUnit	unit,
		bool	arrangementChangeAllowed
	)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

OnUnitLostMount()

void TaleWorlds.MountAndBlade.IFormationArrangement.OnUnitLostMount

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

GetDirectionChangeTendencyOfUnit()

float TaleWorlds.MountAndBlade.IFormationArrangement.GetDirectionChangeTendencyOfUnit

(

IFormationUnit

unit

)

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

Property Documentation

Width

float TaleWorlds.MountAndBlade.IFormationArrangement.Width

getset

Implemented in TaleWorlds.MountAndBlade.CircularFormation, TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, and TaleWorlds.MountAndBlade.SquareFormation.

Depth

float TaleWorlds.MountAndBlade.IFormationArrangement.Depth

get

Implemented in TaleWorlds.MountAndBlade.CircularFormation, TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, and TaleWorlds.MountAndBlade.SquareFormation.

FlankWidth

float TaleWorlds.MountAndBlade.IFormationArrangement.FlankWidth

getset

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

RankDepth

float TaleWorlds.MountAndBlade.IFormationArrangement.RankDepth

get

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

MinimumWidth

float TaleWorlds.MountAndBlade.IFormationArrangement.MinimumWidth

get

Implemented in TaleWorlds.MountAndBlade.CircularFormation, TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, and TaleWorlds.MountAndBlade.SquareFormation.

MaximumWidth

float TaleWorlds.MountAndBlade.IFormationArrangement.MaximumWidth

get

Implemented in TaleWorlds.MountAndBlade.CircularFormation, TaleWorlds.MountAndBlade.CircularSchiltronFormation, TaleWorlds.MountAndBlade.ColumnFormation, TaleWorlds.MountAndBlade.LineFormation, TaleWorlds.MountAndBlade.RectilinearSchiltronFormation, and TaleWorlds.MountAndBlade.SquareFormation.

MinimumFlankWidth

float TaleWorlds.MountAndBlade.IFormationArrangement.MinimumFlankWidth

get

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

IsLoose

bool? TaleWorlds.MountAndBlade.IFormationArrangement.IsLoose

get

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

UnitCount

int TaleWorlds.MountAndBlade.IFormationArrangement.UnitCount

get

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

RankCount

int TaleWorlds.MountAndBlade.IFormationArrangement.RankCount

get

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

PositionedUnitCount

int TaleWorlds.MountAndBlade.IFormationArrangement.PositionedUnitCount

get

Implemented in TaleWorlds.MountAndBlade.ColumnFormation, and TaleWorlds.MountAndBlade.LineFormation.

AreLocalPositionsDirty

bool TaleWorlds.MountAndBlade.IFormationArrangement.AreLocalPositionsDirty

set

Implemented in TaleWorlds.MountAndBlade.LineFormation.

Event Documentation

OnWidthChanged

Action TaleWorlds.MountAndBlade.IFormationArrangement.OnWidthChanged

OnShapeChanged

Action TaleWorlds.MountAndBlade.IFormationArrangement.OnShapeChanged