TaleWorlds.CampaignSystem.Roster.TroopRoster Class Reference

Inherits TaleWorlds.Library.ISerializableObject.

Public Member Functions
	TroopRoster (PartyBase ownerParty)
override int	GetHashCode ()
FlattenedTroopRoster	ToFlattenedRoster ()
void	Add (IEnumerable< FlattenedTroopRosterElement > elementList)
void	Add (TroopRoster troopRoster)
void	Add (TroopRosterElement troopRosterElement)
ICollection< TroopRosterElement >	RemoveIf (Predicate< TroopRosterElement > match)
int	FindIndexOfTroop (CharacterObject character)
	Finds index of specified character in the roster. Returns a negative number if not found.
CharacterObject	GetManAtIndexFromFlattenedRosterWithFilter (int indexOfTroop, bool includeHeroes=false, bool countOnlyHealthyOnes=false)
void	KillNumberOfMenRandomly (int numberOfMen, bool includeHeroes)
void	WoundNumberOfTroopsRandomly (int numberOfMen)
int	AddToCountsAtIndex (int index, int countChange, int woundedCountChange=0, int xpChange=0, bool removeDepleted=true)
void	CheckValidity ()
int	AddToCounts (CharacterObject character, int count, bool insertAtFront=false, int woundedCount=0, int xpChange=0, bool removeDepleted=true, int index=-1)
int	GetTroopCount (CharacterObject troop)
void	RemoveZeroCounts ()
TroopRosterElement	GetElementCopyAtIndex (int index)
void	SetElementNumber (int index, int number)
int	GetElementNumber (int index)
int	GetElementNumber (CharacterObject character)
void	SetElementWoundedNumber (int index, int number)
int	GetElementWoundedNumber (int index)
void	SetElementXp (int index, int number)
int	GetElementXp (int index)
int	GetElementXp (CharacterObject character)
CharacterObject	GetCharacterAtIndex (int index)
void	FillMembersOfRoster (int neededNumber, CharacterObject basicTroop=null)
void	WoundMembersOfRoster (float woundedRatio)
void	Reset ()
override bool	Equals (object obj)
bool	Contains (CharacterObject character)
void	ValidateTroopListCache ()
MBList< TroopRosterElement >	GetTroopRoster ()
void	Clear ()
int	AddXpToTroop (int xpAmount, CharacterObject attackerTroop)
int	AddXpToTroopAtIndex (int xpAmount, int index)
void	RemoveTroop (CharacterObject troop, int numberToRemove=1, UniqueTroopDescriptor troopSeed=default(UniqueTroopDescriptor), int xp=0)
void	WoundTroop (CharacterObject troop, int numberToWound=1, UniqueTroopDescriptor troopSeed=default(UniqueTroopDescriptor))
void	SlideTroops (int firstTroopIndex, int newIndex)
int	Sum (Func< TroopRosterElement, int > selector)
void	OnHeroHealthStatusChanged (Hero hero)
void	ClearTempXp ()
void	UpdateVersion ()
TroopRoster	CloneRosterData ()
void	DeserializeFrom (IReader reader)
void	SerializeTo (IWriter writer)

Static Public Member Functions
static TroopRoster	CreateDummyTroopRoster ()
static void	CalculateCachedStatsOnLoad ()
static bool	operator== (TroopRoster a, TroopRoster b)
static bool	operator!= (TroopRoster a, TroopRoster b)

Properties
int	Count [get]
int	VersionNo [get]
int	TotalRegulars [get]
int	TotalWoundedRegulars [get]
int	TotalWoundedHeroes [get]
int	TotalHeroes [get]
int	TotalWounded [get]
int	TotalManCount [get]
int	TotalHealthyCount [get]
bool	IsPrisonRoster [get, set]

Constructor & Destructor Documentation

TroopRoster()

TaleWorlds.CampaignSystem.Roster.TroopRoster.TroopRoster

(

PartyBase

ownerParty

)

Member Function Documentation

CreateDummyTroopRoster()

static TroopRoster TaleWorlds.CampaignSystem.Roster.TroopRoster.CreateDummyTroopRoster ( )

static

GetHashCode()

override int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetHashCode

(

)

CalculateCachedStatsOnLoad()

static void TaleWorlds.CampaignSystem.Roster.TroopRoster.CalculateCachedStatsOnLoad ( )

static

ToFlattenedRoster()

FlattenedTroopRoster TaleWorlds.CampaignSystem.Roster.TroopRoster.ToFlattenedRoster

(

)

Add() [1/3]

void TaleWorlds.CampaignSystem.Roster.TroopRoster.Add

(

IEnumerable< FlattenedTroopRosterElement >

elementList

)

Add() [2/3]

void TaleWorlds.CampaignSystem.Roster.TroopRoster.Add

(

TroopRoster

troopRoster

)

Add() [3/3]

void TaleWorlds.CampaignSystem.Roster.TroopRoster.Add

(

TroopRosterElement

troopRosterElement

)

RemoveIf()

ICollection< TroopRosterElement > TaleWorlds.CampaignSystem.Roster.TroopRoster.RemoveIf

(

Predicate< TroopRosterElement >

match

)

FindIndexOfTroop()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.FindIndexOfTroop

(

CharacterObject

character

)

Parameters

character

Returns

index of specified character

GetManAtIndexFromFlattenedRosterWithFilter()

CharacterObject TaleWorlds.CampaignSystem.Roster.TroopRoster.GetManAtIndexFromFlattenedRosterWithFilter	(	int	indexOfTroop,
		bool	includeHeroes = false,
		bool	countOnlyHealthyOnes = false
	)

KillNumberOfMenRandomly()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.KillNumberOfMenRandomly	(	int	numberOfMen,
		bool	includeHeroes
	)

WoundNumberOfTroopsRandomly()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.WoundNumberOfTroopsRandomly

(

int

numberOfMen

)

AddToCountsAtIndex()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.AddToCountsAtIndex	(	int	index,
		int	countChange,
		int	woundedCountChange = 0,
		int	xpChange = 0,
		bool	removeDepleted = true
	)

CheckValidity()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.CheckValidity

(

)

AddToCounts()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.AddToCounts	(	CharacterObject	character,
		int	count,
		bool	insertAtFront = false,
		int	woundedCount = 0,
		int	xpChange = 0,
		bool	removeDepleted = true,
		int	index = -1
	)

GetTroopCount()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetTroopCount

(

CharacterObject

troop

)

RemoveZeroCounts()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.RemoveZeroCounts

(

)

GetElementCopyAtIndex()

TroopRosterElement TaleWorlds.CampaignSystem.Roster.TroopRoster.GetElementCopyAtIndex

(

int

index

)

SetElementNumber()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.SetElementNumber	(	int	index,
		int	number
	)

GetElementNumber() [1/2]

int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetElementNumber

(

int

index

)

GetElementNumber() [2/2]

int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetElementNumber

(

CharacterObject

character

)

SetElementWoundedNumber()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.SetElementWoundedNumber	(	int	index,
		int	number
	)

GetElementWoundedNumber()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetElementWoundedNumber

(

int

index

)

SetElementXp()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.SetElementXp	(	int	index,
		int	number
	)

GetElementXp() [1/2]

int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetElementXp

(

int

index

)

GetElementXp() [2/2]

int TaleWorlds.CampaignSystem.Roster.TroopRoster.GetElementXp

(

CharacterObject

character

)

GetCharacterAtIndex()

CharacterObject TaleWorlds.CampaignSystem.Roster.TroopRoster.GetCharacterAtIndex

(

int

index

)

FillMembersOfRoster()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.FillMembersOfRoster	(	int	neededNumber,
		CharacterObject	basicTroop = null
	)

WoundMembersOfRoster()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.WoundMembersOfRoster

(

float

woundedRatio

)

Reset()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.Reset

(

)

Equals()

override bool TaleWorlds.CampaignSystem.Roster.TroopRoster.Equals

(

object

obj

)

operator==()

static bool TaleWorlds.CampaignSystem.Roster.TroopRoster.operator== ( TroopRoster  a, TroopRoster  b  )

static

operator!=()

static bool TaleWorlds.CampaignSystem.Roster.TroopRoster.operator!= ( TroopRoster  a, TroopRoster  b  )

static

Contains()

bool TaleWorlds.CampaignSystem.Roster.TroopRoster.Contains

(

CharacterObject

character

)

ValidateTroopListCache()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.ValidateTroopListCache

(

)

GetTroopRoster()

MBList< TroopRosterElement > TaleWorlds.CampaignSystem.Roster.TroopRoster.GetTroopRoster

(

)

Clear()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.Clear

(

)

AddXpToTroop()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.AddXpToTroop	(	int	xpAmount,
		CharacterObject	attackerTroop
	)

AddXpToTroopAtIndex()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.AddXpToTroopAtIndex	(	int	xpAmount,
		int	index
	)

RemoveTroop()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.RemoveTroop	(	CharacterObject	troop,
		int	numberToRemove = 1,
		UniqueTroopDescriptor	troopSeed = default(UniqueTroopDescriptor),
		int	xp = 0
	)

WoundTroop()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.WoundTroop	(	CharacterObject	troop,
		int	numberToWound = 1,
		UniqueTroopDescriptor	troopSeed = default(UniqueTroopDescriptor)
	)

SlideTroops()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.SlideTroops	(	int	firstTroopIndex,
		int	newIndex
	)

Sum()

int TaleWorlds.CampaignSystem.Roster.TroopRoster.Sum

(

Func< TroopRosterElement, int >

selector

)

OnHeroHealthStatusChanged()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.OnHeroHealthStatusChanged

(

Hero

hero

)

ClearTempXp()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.ClearTempXp

(

)

UpdateVersion()

void TaleWorlds.CampaignSystem.Roster.TroopRoster.UpdateVersion

(

)

CloneRosterData()

TroopRoster TaleWorlds.CampaignSystem.Roster.TroopRoster.CloneRosterData

(

)

Property Documentation

Count

int TaleWorlds.CampaignSystem.Roster.TroopRoster.Count

get

VersionNo

int TaleWorlds.CampaignSystem.Roster.TroopRoster.VersionNo

get

TotalRegulars

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalRegulars

get

TotalWoundedRegulars

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalWoundedRegulars

get

TotalWoundedHeroes

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalWoundedHeroes

get

TotalHeroes

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalHeroes

get

TotalWounded

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalWounded

get

TotalManCount

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalManCount

get

TotalHealthyCount

int TaleWorlds.CampaignSystem.Roster.TroopRoster.TotalHealthyCount

get

IsPrisonRoster

bool TaleWorlds.CampaignSystem.Roster.TroopRoster.IsPrisonRoster

getset