TaleWorlds.MountAndBlade.ColumnFormation Class Reference

Single file formation

Inherits TaleWorlds.MountAndBlade.IFormationArrangement.

Public Member Functions
	ColumnFormation (IFormation ownerFormation, IFormationUnit vanguard=null, int columnCount=1)
IFormationArrangement	Clone (IFormation formation)
void	DeepCopyFrom (IFormationArrangement arrangement)
List< IFormationUnit >	GetAllUnits ()
List< 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. More...
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 More...
void	OnBatchRemoveStart ()
	Notifies the arrangement that remove operations will be done in batch for performance. Child arrangements should provide their own implementation. More...
void	OnBatchRemoveEnd ()
Vec2?	GetLocalPositionOfUnitOrDefault (int unitIndex)
Vec2?	GetLocalDirectionOfUnitOrDefault (int unitIndex)
Engine.? WorldPosition	GetWorldPositionOfUnitOrDefault (int unitIndex)
Vec2?	GetLocalPositionOfUnitOrDefault (IFormationUnit unit)
Vec2?	GetLocalPositionOfUnitOrDefaultWithAdjustment (IFormationUnit unit, float distanceBetweenAgentsAdjustment)
Engine.? WorldPosition	GetWorldPositionOfUnitOrDefault (IFormationUnit unit)
Vec2?	GetLocalDirectionOfUnitOrDefault (IFormationUnit unit)
List< IFormationUnit >	GetUnitsToPop (int count)
List< IFormationUnit >	GetUnitsToPop (int count, Vec3 targetPosition)
IEnumerable< IFormationUnit >	GetUnitsToPopWithCondition (int count, Func< IFormationUnit, bool > currentCondition)
void	SwitchUnitLocations (IFormationUnit firstUnit, IFormationUnit secondUnit)
void	SwitchUnitLocationsWithUnpositionedUnit (IFormationUnit firstUnit, IFormationUnit secondUnit)
void	SwitchUnitLocationsAfterUnitAddition (IFormationUnit addedUnit)
float	GetUnitsDistanceToFrontLine (IFormationUnit unit)
Vec2?	GetLocalDirectionOfRelativeFormationLocation (IFormationUnit unit)
Vec2?	GetLocalWallDirectionOfRelativeFormationLocation (IFormationUnit unit)
IEnumerable< Vec2 >	GetUnavailableUnitPositions ()
float	GetOccupationWidth (int unitCount)
Vec2?	CreateNewPosition (int unitIndex)
void	InvalidateCacheOfUnitAux (Vec2 roundedLocalPosition)
void	BeforeFormationFrameChange ()
void	OnFormationFrameChanged ()
void	OnUnitLostMount (IFormationUnit unit)
bool	IsTurnBackwardsNecessary (Vec2 previousPosition, WorldPosition? newPosition, Vec2 previousDirection, bool hasNewDirection, Vec2? newDirection)
void	TurnBackwards ()
void	OnFormationDispersed ()
void	Reset ()
virtual void	RearrangeFrom (IFormationArrangement arrangement)
virtual void	RearrangeTo (IFormationArrangement arrangement)
virtual void	RearrangeTransferUnits (IFormationArrangement arrangement)
void	FormFromWidth (float width)
IFormationUnit	GetNeighborUnitOfLeftSide (IFormationUnit unit)
IFormationUnit	GetNeighborUnitOfRightSide (IFormationUnit unit)
void	ReserveMiddleFrontUnitPosition (IFormationUnit vanguard)
void	ReleaseMiddleFrontUnitPosition ()
Vec2	GetLocalPositionOfReservedUnitPosition ()
void	OnTickOccasionallyOfUnit (IFormationUnit unit, bool arrangementChangeAllowed)
float	GetDirectionChangeTendencyOfUnit (IFormationUnit unit)
IEnumerable< T >	GetUnitsAtVanguardFile< T > ()
List< IFormationUnit >	GetAllUnits ()
List< 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. More...
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 More...
void	OnBatchRemoveStart ()
	Notifies the arrangement that remove operations will be done in batch for performance. Child arrangements should provide their own implementation. More...
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	SwitchUnitLocationsAfterUnitAddition (IFormationUnit addedUnit)
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)

Protected Member Functions
int	GetUnitCountWithOverride ()

Properties
IFormationUnit	Vanguard [get]
	Forward unit of the column More...
int	ColumnCount [get, set]
int	FileCount [get]
int	RankCount [get]
float	Distance [get]
	Space between units in the direction of depth More...
float	Interval [get]
	The lateral space between units on one same line More...
float	Width [get, set]
	The space occupied by the formation, measured from one flank to the other More...
float	Depth [get]
	The space from front to rear of the formation More...
float	MinimumWidth [get]
bool?	IsLoose [get]
int	UnitCount [get]
int	PositionedUnitCount [get]
Properties inherited from TaleWorlds.MountAndBlade.IFormationArrangement
float	Width [get, set]
	The space occupied by the formation, measured from one flank to the other More...
float	Depth [get]
	The space from front to rear of the formation More...
float	MinimumWidth [get]
bool?	IsLoose [get]
int	UnitCount [get]
int	RankCount [get]
int	PositionedUnitCount [get]
bool	AreLocalPositionsDirty [set]

Events
Action	OnWidthChanged
Action	OnShapeChanged
Events inherited from TaleWorlds.MountAndBlade.IFormationArrangement
Action	OnWidthChanged
Action	OnShapeChanged

Constructor & Destructor Documentation

ColumnFormation()

TaleWorlds.MountAndBlade.ColumnFormation.ColumnFormation	(	IFormation	ownerFormation,
		IFormationUnit	vanguard = null,
		int	columnCount = 1
	)

Member Function Documentation

Clone()

IFormationArrangement TaleWorlds.MountAndBlade.ColumnFormation.Clone

(

IFormation

formation

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

DeepCopyFrom()

void TaleWorlds.MountAndBlade.ColumnFormation.DeepCopyFrom

(

IFormationArrangement

arrangement

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetAllUnits()

List< IFormationUnit > TaleWorlds.MountAndBlade.ColumnFormation.GetAllUnits

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnpositionedUnits()

List< IFormationUnit > TaleWorlds.MountAndBlade.ColumnFormation.GetUnpositionedUnits

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

AddUnit()

bool TaleWorlds.MountAndBlade.ColumnFormation.AddUnit

(

IFormationUnit

unit

)

Parameters

unit

Returns

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

RemoveUnit()

void TaleWorlds.MountAndBlade.ColumnFormation.RemoveUnit

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnit()

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

OnBatchRemoveStart()

void TaleWorlds.MountAndBlade.ColumnFormation.OnBatchRemoveStart

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

OnBatchRemoveEnd()

void TaleWorlds.MountAndBlade.ColumnFormation.OnBatchRemoveEnd

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetLocalPositionOfUnitOrDefault() [1/2]

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.GetLocalPositionOfUnitOrDefault

(

int

unitIndex

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetLocalDirectionOfUnitOrDefault() [1/2]

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.GetLocalDirectionOfUnitOrDefault

(

int

unitIndex

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetWorldPositionOfUnitOrDefault() [1/2]

Engine.? WorldPosition TaleWorlds.MountAndBlade.ColumnFormation.GetWorldPositionOfUnitOrDefault

(

int

unitIndex

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetLocalPositionOfUnitOrDefault() [2/2]

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.GetLocalPositionOfUnitOrDefault

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetLocalPositionOfUnitOrDefaultWithAdjustment()

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetWorldPositionOfUnitOrDefault() [2/2]

Engine.? WorldPosition TaleWorlds.MountAndBlade.ColumnFormation.GetWorldPositionOfUnitOrDefault

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetLocalDirectionOfUnitOrDefault() [2/2]

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.GetLocalDirectionOfUnitOrDefault

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnitsToPop() [1/2]

List< IFormationUnit > TaleWorlds.MountAndBlade.ColumnFormation.GetUnitsToPop

(

int

count

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnitsToPop() [2/2]

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnitsToPopWithCondition()

IEnumerable< IFormationUnit > TaleWorlds.MountAndBlade.ColumnFormation.GetUnitsToPopWithCondition	(	int	count,
		Func< IFormationUnit, bool >	currentCondition
	)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

SwitchUnitLocations()

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

SwitchUnitLocationsWithUnpositionedUnit()

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

SwitchUnitLocationsAfterUnitAddition()

void TaleWorlds.MountAndBlade.ColumnFormation.SwitchUnitLocationsAfterUnitAddition

(

IFormationUnit

addedUnit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnitsDistanceToFrontLine()

float TaleWorlds.MountAndBlade.ColumnFormation.GetUnitsDistanceToFrontLine

(

IFormationUnit

unit

)

GetLocalDirectionOfRelativeFormationLocation()

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.GetLocalDirectionOfRelativeFormationLocation

(

IFormationUnit

unit

)

GetLocalWallDirectionOfRelativeFormationLocation()

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.GetLocalWallDirectionOfRelativeFormationLocation

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnavailableUnitPositions()

IEnumerable< Vec2 > TaleWorlds.MountAndBlade.ColumnFormation.GetUnavailableUnitPositions

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetOccupationWidth()

float TaleWorlds.MountAndBlade.ColumnFormation.GetOccupationWidth

(

int

unitCount

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

CreateNewPosition()

Vec2? TaleWorlds.MountAndBlade.ColumnFormation.CreateNewPosition

(

int

unitIndex

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

InvalidateCacheOfUnitAux()

void TaleWorlds.MountAndBlade.ColumnFormation.InvalidateCacheOfUnitAux

(

Vec2

roundedLocalPosition

)

BeforeFormationFrameChange()

void TaleWorlds.MountAndBlade.ColumnFormation.BeforeFormationFrameChange

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

OnFormationFrameChanged()

void TaleWorlds.MountAndBlade.ColumnFormation.OnFormationFrameChanged

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

OnUnitLostMount()

void TaleWorlds.MountAndBlade.ColumnFormation.OnUnitLostMount

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

IsTurnBackwardsNecessary()

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

TurnBackwards()

void TaleWorlds.MountAndBlade.ColumnFormation.TurnBackwards

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

OnFormationDispersed()

void TaleWorlds.MountAndBlade.ColumnFormation.OnFormationDispersed

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

Reset()

void TaleWorlds.MountAndBlade.ColumnFormation.Reset

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

RearrangeFrom()

virtual void TaleWorlds.MountAndBlade.ColumnFormation.RearrangeFrom ( IFormationArrangement  arrangement )

virtual

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

RearrangeTo()

virtual void TaleWorlds.MountAndBlade.ColumnFormation.RearrangeTo ( IFormationArrangement  arrangement )

virtual

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

RearrangeTransferUnits()

virtual void TaleWorlds.MountAndBlade.ColumnFormation.RearrangeTransferUnits ( IFormationArrangement  arrangement )

virtual

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnitCountWithOverride()

int TaleWorlds.MountAndBlade.ColumnFormation.GetUnitCountWithOverride ( )

protected

FormFromWidth()

void TaleWorlds.MountAndBlade.ColumnFormation.FormFromWidth

(

float

width

)

GetNeighborUnitOfLeftSide()

IFormationUnit TaleWorlds.MountAndBlade.ColumnFormation.GetNeighborUnitOfLeftSide

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetNeighborUnitOfRightSide()

IFormationUnit TaleWorlds.MountAndBlade.ColumnFormation.GetNeighborUnitOfRightSide

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

ReserveMiddleFrontUnitPosition()

void TaleWorlds.MountAndBlade.ColumnFormation.ReserveMiddleFrontUnitPosition

(

IFormationUnit

vanguard

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

ReleaseMiddleFrontUnitPosition()

void TaleWorlds.MountAndBlade.ColumnFormation.ReleaseMiddleFrontUnitPosition

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetLocalPositionOfReservedUnitPosition()

Vec2 TaleWorlds.MountAndBlade.ColumnFormation.GetLocalPositionOfReservedUnitPosition

(

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

OnTickOccasionallyOfUnit()

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

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetDirectionChangeTendencyOfUnit()

float TaleWorlds.MountAndBlade.ColumnFormation.GetDirectionChangeTendencyOfUnit

(

IFormationUnit

unit

)

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

GetUnitsAtVanguardFile< T >()

IEnumerable< T > TaleWorlds.MountAndBlade.ColumnFormation.GetUnitsAtVanguardFile< T >

(

)

Type Constraints

T

:

IFormationUnit

Property Documentation

Vanguard

IFormationUnit TaleWorlds.MountAndBlade.ColumnFormation.Vanguard

get

ColumnCount

int TaleWorlds.MountAndBlade.ColumnFormation.ColumnCount

getset

FileCount

int TaleWorlds.MountAndBlade.ColumnFormation.FileCount

getprotected

RankCount

int TaleWorlds.MountAndBlade.ColumnFormation.RankCount

get

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

Distance

float TaleWorlds.MountAndBlade.ColumnFormation.Distance

getprotected

Interval

float TaleWorlds.MountAndBlade.ColumnFormation.Interval

getprotected

Width

float TaleWorlds.MountAndBlade.ColumnFormation.Width

getset

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

Depth

float TaleWorlds.MountAndBlade.ColumnFormation.Depth

get

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

MinimumWidth

float TaleWorlds.MountAndBlade.ColumnFormation.MinimumWidth

get

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

IsLoose

bool? TaleWorlds.MountAndBlade.ColumnFormation.IsLoose

get

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

UnitCount

int TaleWorlds.MountAndBlade.ColumnFormation.UnitCount

get

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

PositionedUnitCount

int TaleWorlds.MountAndBlade.ColumnFormation.PositionedUnitCount

get

Implements TaleWorlds.MountAndBlade.IFormationArrangement.

Event Documentation

OnWidthChanged

Action TaleWorlds.MountAndBlade.ColumnFormation.OnWidthChanged

OnShapeChanged

Action TaleWorlds.MountAndBlade.ColumnFormation.OnShapeChanged