TaleWorlds.CampaignSystem.BattleSimulation Class Reference

This class will handle all battle simulations (normal battle, siege etc) where the player choose to order his troops to attack while the hero stays back.

Inherits TaleWorlds.Core.IBattleObserver.

Public Member Functions
	BattleSimulation (FlattenedTroopRoster selectedTroopsForPlayerSide, FlattenedTroopRoster selectedTroopsForOtherSide)
void	Play ()
void	FastForward ()
void	Skip ()
void	Pause ()
void	OnFinished ()
void	OnPlayerRetreat ()
void	Tick (float dt)
void	ResetSimulation ()
void	TroopNumberChanged (BattleSideEnum side, IBattleCombatant battleCombatant, BasicCharacterObject character, int number=0, int numberKilled=0, int numberWounded=0, int numberRouted=0, int killCount=0, int numberReadyToUpgrade=0)
void	HeroSkillIncreased (BattleSideEnum side, IBattleCombatant battleCombatant, BasicCharacterObject heroCharacter, SkillObject skill)
void	BattleResultsReady ()
void	TroopSideChanged (BattleSideEnum prevSide, BattleSideEnum newSide, IBattleCombatant battleCombatant, BasicCharacterObject character)

Public Attributes
readonly FlattenedTroopRoster[]	SelectedTroops = new FlattenedTroopRoster[2]

Properties
bool	IsSimulationFinished [get]
MapEvent	MapEvent [get]
bool	IsPlayerRetreated [get]
IBattleObserver	BattleObserver [get, set]
List< List< BattleResultPartyData > >	Teams [get]

Constructor & Destructor Documentation

BattleSimulation()

TaleWorlds.CampaignSystem.BattleSimulation.BattleSimulation	(	FlattenedTroopRoster	selectedTroopsForPlayerSide,
		FlattenedTroopRoster	selectedTroopsForOtherSide )

Member Function Documentation

Play()

void TaleWorlds.CampaignSystem.BattleSimulation.Play

(

)

FastForward()

void TaleWorlds.CampaignSystem.BattleSimulation.FastForward

(

)

Skip()

void TaleWorlds.CampaignSystem.BattleSimulation.Skip

(

)

Pause()

void TaleWorlds.CampaignSystem.BattleSimulation.Pause

(

)

OnFinished()

void TaleWorlds.CampaignSystem.BattleSimulation.OnFinished

(

)

OnPlayerRetreat()

void TaleWorlds.CampaignSystem.BattleSimulation.OnPlayerRetreat

(

)

Tick()

void TaleWorlds.CampaignSystem.BattleSimulation.Tick

(

float

dt

)

ResetSimulation()

void TaleWorlds.CampaignSystem.BattleSimulation.ResetSimulation

(

)

TroopNumberChanged()

void TaleWorlds.CampaignSystem.BattleSimulation.TroopNumberChanged	(	BattleSideEnum	side,
		IBattleCombatant	battleCombatant,
		BasicCharacterObject	character,
		int	number = 0,
		int	numberKilled = 0,
		int	numberWounded = 0,
		int	numberRouted = 0,
		int	killCount = 0,
		int	numberReadyToUpgrade = 0 )

Implements TaleWorlds.Core.IBattleObserver.

HeroSkillIncreased()

void TaleWorlds.CampaignSystem.BattleSimulation.HeroSkillIncreased	(	BattleSideEnum	side,
		IBattleCombatant	battleCombatant,
		BasicCharacterObject	heroCharacter,
		SkillObject	skill )

Implements TaleWorlds.Core.IBattleObserver.

BattleResultsReady()

void TaleWorlds.CampaignSystem.BattleSimulation.BattleResultsReady

(

)

Implements TaleWorlds.Core.IBattleObserver.

TroopSideChanged()

void TaleWorlds.CampaignSystem.BattleSimulation.TroopSideChanged	(	BattleSideEnum	prevSide,
		BattleSideEnum	newSide,
		IBattleCombatant	battleCombatant,
		BasicCharacterObject	character )

Implements TaleWorlds.Core.IBattleObserver.

Member Data Documentation

SelectedTroops

readonly FlattenedTroopRoster [] TaleWorlds.CampaignSystem.BattleSimulation.SelectedTroops = new FlattenedTroopRoster[2]

Property Documentation

IsSimulationFinished

bool TaleWorlds.CampaignSystem.BattleSimulation.IsSimulationFinished

get

MapEvent

MapEvent TaleWorlds.CampaignSystem.BattleSimulation.MapEvent

get

IsPlayerRetreated

bool TaleWorlds.CampaignSystem.BattleSimulation.IsPlayerRetreated

get

BattleObserver

IBattleObserver TaleWorlds.CampaignSystem.BattleSimulation.BattleObserver

getset

Teams

List<List<BattleResultPartyData> > TaleWorlds.CampaignSystem.BattleSimulation.Teams

get